Modify a Payment Request

patch

https://api.test.payadvantage.com.au/v3/payment_requests/{code}

Payment Requests let you receive a payment by creating a link with preconfigured payment options that can then be:
- used in your integration/application allowing a customer to click/follow a link through a button
- sent through your own system in emails, sms or letters
- sent in an email/sms by the PayAdvantage system.

You are able to configure the options available when the link is followed such as the customer, description of the payment being requested, amount, on-charge fees (not available for BPAY), ExternalID (use-full for tracking subsequent payments), payment options and if you would like us to email/sms the initial link and reminders to the customer.

Resend a payment request by providing the amount of days the payment request can remain active.

Path Params

code

string

required

Body Params

ExpiryDays

int32 | null

Setting this will update the payment request to expire the specified number of days from today.

SendLink

boolean

required

When set to true Pay Advantage will send the payment request to the customer by email and/or text message.

PaymentOptions

array of strings | null

Options: credit_card, pay_id, pay_to, bpay, payment_plan, credit_card_authorization, card_authentication_request.
Specify which payment options are available as an array of strings. If using payment plans please ensure you configure the payment plan options in hosted pages.

credit_card allows card payments.
pay_id allows the user to pay using PayID
pay_to allows the user to pay using PayTo

bpay allows BPAY payments.
payment_plan allows the user to pay in installments.
credit_card_authorization requests a hold to be placed on the card. It cannot be combined with other payment options.
card_authentication_request sends a link for an existing credit card payment that requires 3DS authentication. It cannot be combined with other payment options.

PaymentOptions

Description

string | null

Setting this will update the payment request description

Amount

double | null

Setting this will update the amount requested to be debited from the customer by the payment request in AUD e.g. $100 would be amount=100.00

Responses

200

400Bad request

401User is not authorized

403The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort

404The requested resource could not be found

422The request was well-formed but was unable to be followed due to semantic errors

429Request limit exceeded

500Internal server error

504Gateway timeout