Update payment link details

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

Use this endpoint to update payment link details

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

status of the payment link

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

Response body

object

title

string

Defaults to Bad request.

details

string

error details

E400-21: representative object is missing E400-1: merchant name is missing E400-4: merchant country is missing E400-2: representative email is missing E400-1: representative name is missing E400-0: representative address is missing E400-0: Unexpected Error E400-6: Amount is missing E400-10: Invalid Country format E400-12: Currency is missing E400-13: PaymentType is missing E400-0: NotificationDict is missing E400-0: Notification value is missing E400-0: SettingDict is missing E400-0: Setting value is missing or not allowed E400-18: IBAN is missing E400-19: beneficiaryName is missing E400-0: Header media-type is missing E400-0: Header Content-Type is missing E400-22: Unsupported media type. Supported type are pdf, jpeg and png E400-23: Unsupported media type. use png E400-16: File size must not exceed 4ko E400-17: File size must not exceed 1Mo E400-0: password is missing E401-1: bearer token or apikey is missing E401-2: bearer token is missing E401-4: Cannot delete public key E400-0: apikey is missing E403-1: Access right not sufficient E400-0: Bad id is passed E400-7: Invalid Name Format E400-8: Invalid Email Format E400-9: Invalid phone number Format E400-3: phone number is required E400-20: Expired Or Bad OTP or Bad PhoneNumberId E400-20: Expired Or Bad OTP or Bad MerchantId E400-20: Expired Or Bad OTP E403-2: 2FA authentication is required E409-1 Merchant Representation has already an account E400-24: Selected Currency is not yet supported for this country E400-20: Resource is no longer available E400-25: Payment type is disabled by merchant E400-0: Bad transactionId is passed E400-0: Bad transaction type is passed E400-26: Invoice or Order is paid or expired E400-27: payment link is paid or expired E400-0: Missing or Bad search key E400-28: Money transfer is not authorized for this merchant E400-0 offline checkout write is missing E401-1: Invalid Token E401-3: Invalid apikey E400-0: type is missing in request body E400-0: bad or missing scope in request body E400-0: unknown apikeyId E400-0: account status is missing E400-0: merchantId is missing E400-0: callbackUrl is missing E400-0: bad type is passed E400-0: bad cardId is passed E400-0: bad merchant id is passed E400-0: unknown or unauthorized permission is passed E400-0 card info is missing E400-01: Order name is missing E400-0: Order id must be in UUID format E400-0: Same Idempotency is passed E400-29: product price is missing in a Item line Object E400-30: product quantity is missing in a Item line Object E400-31: Due date is required E400-1: Name is missing E400-32: Already expired E404-1: Cannot find resource E400-33: Wrong payment type or disabled E400-34: User does not have a secret Code E400-35: SecretCode is locked, you must reset it E400-36: Wrong secret code is passed E400-37: Secret code is missing E400-38: Insufficient balance E400-00: country is missing E400-39: Wrong country is passed E400-40: Invoice is expired E400-41: Wrong date format is used E400-42: Invalid Category format E400-43: Invalid City format E400-44:Merchant does not exist E400-45: Invalid Reference format E400-46: Invalid paymentReference format E400-47: Invoice is already paid E400-48: Payment link already paid E400-49: Error from PSP, Check your account E400-50: Amount exceed available capture E400-51: Wrong secret code is passed E400-52: You must register you phone number first E400-53: You don't have a secret code E400-54: You secret code is locked, do reset E400-0: Payment failed E401-5: Your Account is restricted E401-6: Your Account is not activated

401

The caller is not authenticated

403

Access rights not sufficient

404

Cannot not found payment link. Check paymentLinkId

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.test.bictorys.com/paymentlink-management/v1/paymentlinks/paymentLinkId \
3
     --header 'accept: application/problem+json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/problem+json

400Bad Request

500Internal Server Error.