Update order payments

Updates the status of an order/reservation payment line.
Adds to the line nLine of the order id the amount paymentAmount as paid.
An order can be placed without having completed the full amount of payment and modify the status of the payment lines as they are completed.
Once completed, by invoking the method, commit confirmation of the order is done and thus the customer consolidates the benefits related to that order.
This is used when the business allows deferred payment methods as a bank transfer, leaving the order in the state PaymentPending.
In this case, the user confirms the order, but the benefits associated with it
will only be available when the payment is finally confirmed, through updating the corresponding payment line.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

A unique identifier to reference the Checkout Session.

Body Params

Information to update the payment line

Object with the information of a payment line of an order.

int64

Unique identifier for the object.

string
length between 0 and 50

Code associated with the payment method in the accounting system.

int32

Line number within the order

string
length between 0 and 250

Payment method description

double
required

Amount total paid on this payment line

double
required

Amount captured on this payment line

int64

ID associated with Wapping transaction when Wapping is used as a payment method.

string
length between 0 and 50

INFO:Authorization number for a bank card payment.

string
length between 0 and 50

INFO: Authorization number for a bank card payment.

string
length between 0 and 50

INFO: Reference number associated with the banking operation.

string
length between 0 and 50

INFO: In tokenized operations with bank cards, token associated with that operation.

string
length between 0 and 50

INFO: Bank card number with which the operation was performed.
The card number will be kept masked in compliance with PCI-DSS regulations

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses
200

Everything worked as expected.

422

Unprocessable data in request

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json