Update a payment instruction
1min
PATCH
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
paymentInstructionReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Body Parameters
patchRequest
Microsoft.AspNet.JsonPatch.JsonPatchDocument[FictiveGlobal.Api.Rest.Dtos.v1.Patch.PaymentInstructions.PaymentInstructionPatchModel]
*
value
System.Object
path
string
op
string
from
string
Responses
204
No Content
FictiveGlobal.Api.Rest.Dtos.v1.PaymentInstructions.PaymentInstruction
Description
Represents v1 DTO for the payment instruction
paymentInstructionReference
string
status
string<Pending | Active | Completed | Cancelled>
currency
string
description
string
cartReference
string
fulfilmentPaymentMappings
FictiveGlobal.Api.Rest.Dtos.v1.PaymentInstructions.FulfilmentPaymentMapping[]
customPaymentInstructionParameters
object
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.
Updated 25 Mar 2024
Did this page help you?