---
updatedAt: 2026-05-29T07:02:48.000Z
agentTools:
projectIndex: https://docs.payadvantage.com.au/llms.txt
---
# Modify a Payment Request
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.
# OpenAPI definition
```json
{
"openapi": "3.0.4",
"info": {
"title": "PayAdvantage Web API",
"termsOfService": "https://www.payadvantage.com.au/terms-of-service",
"contact": {
"name": "Support",
"url": "https://help.payadvantage.com.au/hc/en-us/categories/360000110195",
"email": "support@payadvantage.com.au"
},
"version": "v3"
},
"servers": [
{
"url": "https://api.test.payadvantage.com.au/v3/"
}
],
"paths": {
"/payment_requests/{code}": {
"description": "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.
",
"patch": {
"tags": [
"Payment Request"
],
"summary": "Modify a Payment Request",
"description": "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.",
"operationId": "payment_requests_patch",
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendPaymentRequestRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "User is not authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "The 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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "The requested resource could not be found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "The request was well-formed but was unable to be followed due to semantic errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"429": {
"description": "Request limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"504": {
"description": "Gateway timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ApiErrorResponse": {
"type": "object",
"properties": {
"ErrorCode": {
"type": "string",
"nullable": true,
"example": "abc"
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SendPaymentRequestRequest": {
"required": [
"DateDueSet",
"SendLink"
],
"type": "object",
"properties": {
"ExpiryDays": {
"type": "integer",
"description": "Setting this will update the payment request to expire the specified number of days from today. This number is added on top of the due date if there is one present.",
"format": "int32",
"nullable": true,
"example": 1
},
"SendLink": {
"type": "boolean",
"description": "When set to true Pay Advantage will send the payment request to the customer by email and/or text message.",
"example": true
},
"PaymentOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "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` is available but it will not reconcile the payment request.
`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.",
"nullable": true
},
"Description": {
"maxLength": 100,
"type": "string",
"description": "Setting this will update the payment request description",
"nullable": true,
"example": "abc"
},
"Amount": {
"type": "number",
"description": "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`",
"format": "double",
"nullable": true
},
"SendReminders": {
"type": "boolean",
"description": "Enable or disable payment reminders.",
"nullable": true
},
"DateDue": {
"pattern": "^\\d\\d\\d\\d\\-\\d\\d\\-\\d\\d$",
"type": "string",
"description": "Setting this updates the payment request's due date. Send `null` to clear it; omit the field to leave it unchanged.",
"format": "date",
"nullable": true,
"example": "2022-12-31"
},
"DateDueSet": {
"type": "boolean",
"readOnly": true,
"example": true
},
"OnchargeFees": {
"type": "boolean",
"description": "Setting this will update whether credit card fees are on-charged to the customer. The value is snapshotted into the iframe nonce at iframe load; toggling after the iframe is already open will not affect an in-flight payer session.",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
```