Update payment

Update payment request.

Authorization

Bearer

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Identifier of the payment.

Formatuuid

id*string

Identifier of the payment

Formatuuid

Header Parameters

X-Volt-Api-Version*1

Version of the API used. Currently, version 1 is the only version.

Value in

X-Volt-Initiation-Channel*string

Channel used for payment initiation flow.

Value in

"api"
"hosted"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

openBankingEU?

Definition used for processing transfer with the PSD directive (Open Banking).

Object is allowed if paymentSystem was set to OPEN_BANKING_EU.

openBankingUK?

Definition used for processing transfer with the PSD directive (Open Banking).

Object is allowed if paymentSystem was set to OPEN_BANKING_UK.

nppPayToAU?

Definition used for processing transfer with the Australian NPP (New Payments Platform). Object is present in the response if paymentSystem is set to NPP_PAY_TO_AU.

sca?

Information about strong customer authentication (SCA).

customer?

Customer decision for a verified payment that is awaiting approval.

Send this to resolve the CUSTOMER_APPROVAL required input once Volt has verified the account and matched the payer name.

Response Body

`application/json`

curl -X PATCH "https://example.com/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Volt-Api-Version: 1" \  -H "X-Volt-Initiation-Channel: api" \  -H "Content-Type: application/json" \  -d '{    "openBankingEU": {      "redirectType": "web"    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "currency": "EUR",  "amount": 10000,  "paymentReference": "XV9840MK550AMKQ910",  "internalReference": "H35X48Y4FWOD6G3S",  "paymentSystem": "OPEN_BANKING_EU",  "openBankingEU": {    "type": "BILL",    "institutionId": "cdae5c01-a629-4362-be56-52101ec22a49",    "validityPeriod": 1440,    "provider": "Volt",    "accountIdentifiers": {      "iban": "DE75512108001245126199"    }  },  "payer": {    "reference": "JDOE-101",    "firstName": "John",    "lastName": "Doe",    "organisationName": "JD Holdings",    "email": "johndoe@example.com",    "accountIdentifiers": {      "iban": "DE75512108001245126199"    }  },  "sender": {    "name": "John Doe",    "accountIdentifiers": {      "iban": "DE75512108001245126199"    }  },  "beneficiary": {    "name": "Jane Doe",    "accountIdentifiers": {      "iban": "PL10105000997603123456789123"    }  },  "device": {    "ip": "192.168.0.1",    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",    "fingerprint": "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"  },  "status": "NEW_PAYMENT",  "transferType": "SWIFT",  "displayInfo": [    {      "key": "Product SKU",      "value": "87ec73a0"    }  ],  "createdAt": "2024-04-15T15:52:01+00:00",  "updatedAt": "2005-08-15T15:52:01+00:00",  "paymentInitiationFlow": {    "status": "PROCESSING",    "details": {      "reason": "AWAITING_USER_REDIRECT",      "redirect": {        "url": "https://vo.lt/asqIs",        "directUrl": "https://myBank.com/authorisation?code=xyz"      }    }  }}

Update payment

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

424application/json

500application/json

Example Processing (awaiting user redirect)

Example Waiting for user input (account identification required)

Example Waiting for user input (SCA method required)

Example Waiting for customer approval (Verified Payments)

Example Waiting for user input (customer approval required)

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`