Create additional fulfilment payment

1min

POST
This endpoint will provide the ability to add an additional payment to an existing fulfilment within eSuite
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
fulfilmentReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Body Parameters
payment
FictiveGlobal.Api.Rest.Dtos.v2.PaymentInstructions.AdditionalPayment
*
Description
This is a class used to save additional payments.
paymentDate
string<date-time>
paymentMethod
string
vatAmount
number<double>
grossAmount
number<double>
netAmount
number<double>
currency
string<ZZZ | GBP | EUR | USD | AUD | CAD | SEK | DKK | JPY | FictiveCREDITS | SAR | BGN | TWD | CZK | ILS | HUF | ISK | KRW | NOK | PLN | BRL | CHF | RON | RUB | HRK | ALL | THB | TRY | PKR | IDR | UAH | BYR | EEK | LVL | LTL | TJS | IRR | VND | AMD | AZN | MKD | ZAR | GEL | INR | MYR | KZT | KGS | KES | TMT | UZS | MNT | CNY | KHR | LAK | SYP | LKR | ETB | NPR | AFN | PHP | MVR | NIO | BOB | CLP | NZD | GTQ | RWF | XOF | IQD | MXN | CSD | BND | BDT | DZD | EGP | HKD | PEN | LYD | SGD | BAM | MOP | CRC | MAD | PAB | TND | DOP | OMR | JMD | VEB | YER | COP | RSD | BZD | JOD | TTD | ARS | LBP | ZWL | KWD | AED | UYU | BHD | PYG | QAR | HNL>
customPaymentParameters
object
Responses
202
No Content
400
• Invalid payment date provided
            <br />• Invalid payment method provided
            <br />• Invalid format for VAT amount
            <br />• Invalid format for net amount
            <br />• Invalid format for gross amount
            <br />• Invalid currency provided
401
API Authentication Failure: Invalid Authentication Type/Credentials Provided
404
• Account cannot be found
            <br />• Fulfilment cannot be found
412
• Fulfilments is in an invalid status to add an additional payment
            <br />• Offline payment are not enabled for your instance.
            <br />• The sum of net and VAT must equal the gross amount provided
            <br />• [Currency ISO Code] is not enabled for your instance
            <br />• The currency provided must match that used for other transactions for the fulfilment
            <br />• [Parameter Name] is not configured as a custom payment parameter for your instance
﻿
﻿

🤔

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.

﻿

Updated 02 Nov 2023

Did this page help you?

Update a fulfilment

Retrieve all fulfilments for an account