Update payment link details

put

https://api.test.bictorys.com/paymentlink-management/v1/paymentlinks/{paymentLinkId}

Use this endpoint to update payment link details

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

paymentLinkId

uuid

required

Unique identifier of the payment link.

Body Params

reference

string

payment link reference

description

string

short description intended to the customer

amount

double

required

Required. Amount to collect from customer

currency

string

required

Required. Payment link currency

customerId

uuid

unique identifier of the customer, recipient of the payment link

dueDate

date

paymentlink due date

status

string

enum

status of the payment link

Allowed:

redirectUrlAfterPayment

string

Optional. Provide an url if you want to redirect customer after successful payment is done.

enableMultiplePayment

boolean

Defaults to false

By default, only one payment is authorized on each payment link. In case you want to allow multiple payment (recurrent payment) on this link, set the value to true

deviceId

string

Id of the device that has created the request.

Responses

200

the payment link is updated successfully

401

The caller is not authenticated

403

Access rights not sufficient

404

Cannot not found payment link. Check paymentLinkId

400Bad Request

500Internal Server Error.