Assign Payment

post

https://api.instellix.io/v2/payment-assignments

Create manual assignment between a payment and a given entity: DOCUMENT (invoice, credit memo, ...) or ORDER.

NOTE: When assigning to an order, if the order has exactly one associated document the payment will be assigned to that document instead.

Body Params

Create payment assignment request. If the assigned amount is not explicitly set, the remaining transaction amount is used for payment transaction assignments, and the batch item amount is used for batch items

amount

Amount | null

Assigned amount. If not explicitly set, the remaining transaction amount is used for payment transaction assignments, and the batch item amount is used for batch items

fees

array | null, unique

Optional fee types to assign with this assignment (full fee amounts).
If the list contains "ALL", every fee on the payment is assigned
and any other entries are ignored.
Omitted/null = no fees. Empty array = no fees.
Only fees assigned on payments with category CHARGEBACK affect the related opos case;
fees on other payment categories are stored on the assignment but have no opos-case impact.

ident

string

required

length between 1 and 100

[a-zA-Z0-9_.~-]*

Unique identifier.

paymentBatchItemIdent

string | null

Ident of the payment transaction batch item

paymentIdent

string

required

length between 1 and 255

^\S(.*\S)?$

Ident of the payment transaction.
Must not be null.
Size must be between 1 and 255.
Must match the regular expression ^\S(.*\S)?$.

targetIdent

string

required

length between 1 and 255

^\S(.*\S)?$

Ident of the assignment target, i.e. document or order ident.
Must not be null.
Size must be between 1 and 255.
Must match the regular expression ^\S(.*\S)?$.

targetIdentType

string

required

Type of the assignment target.

NOTE:* This does not necessarily need to be the actual targetType of the resulting assignments,
as for the ident of orders with a single associated document the payment will be assigned to the
document instead.
One of:


DOCUMENT	The target is a document
ORDER	The target is an order

Responses

201The request has been fulfilled, resulting in the creation of a new resource.

4XXClient error

5XXServer error