API Reference
Payment Instruction

Update a payment instruction

1min
PATCH
This endpoint will provide the ability to update a payment instruction for a given account
Authentication
Authorization
Path Parameters
accountReference
*
paymentInstructionReference
*
Header Parameters
X-TokenId
X-SessionId
X-Version
*
Origin
Body Parameters
patchRequest
*
value
path
op
from
Responses
204
No Content
Description
Represents v1 DTO for the payment instruction
paymentInstructionReference
status
currency
description
cartReference
fulfilmentPaymentMappings
customPaymentInstructionParameters
400
Bad Request <br />β€’ The cancellation code is too long <br />β€’ Unable to amend payment instruction <br />β€’ The status can only be set to 'Cancelled'
401
Unauthorized <br />β€’ API Authentication Failure: Invalid Authentication Type/Credentials Provided
403
Forbidden <br />β€’ Cart is already in use and/or bound to another account
404
Not Found <br />β€’ Account cannot be found <br />β€’ Payment instruction cannot be found
412
Precondition Failed <br />β€’ Can not amend payment instruction status that has already been cancelled <br />β€’ PATCH data validation failed. <br />β€’ Carts must contain a minimum of 1 line item.
ο»Ώ

ο»Ώ

πŸ€”
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.

ο»Ώ