Update Payment

patch

https://api-sandbox.paymentlabs.io/batches/{batchId}/payments/{paymentId}

Updates a payment given it is eligible to be updated

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

string

required

paymentId

string

required

Body Params

referenceId

string

External Payment Reference Id
This is used to cross reference this payment between both systems, you should set this the same as the payment id in your own system

sourceAmount

string

The amount to be paid

taxJurisdiction

string

enum

Tax rules to apply to this payment

Required if the you have multiple tax rules
validated against what jurisdictions are turned on for you

Allowed:

paymentCategory

string

enum

Payment category to be used for this payment

payeeMemo

string

Message to be sent to the payee when the payment is made

payorMemo

string

Message to be displayed to you on this payment

200The payment has been updated

401Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.

403 Forbidden response, when the user is authenticated but does not have the necessary permissions.

423 The record is in an state that cannot be edited, check the message and code for more information on why the record cannot be edited. e.g,: When a payment has already been paid, it's value cannot be changed.