This page provides descriptions of Pay By Link (PBL) response parameters. For PBL sample code, see Pay By Link (PBL).

`payment_links`

Please note:

All responses - The payment_links object is required.
Success or partial success - In a success response or a partial success response, the payment_links object contains a payment_link array. See its description below.
Fail - In a fail response, the payment_links object contains a status object. See its description below.

`payment_link`

Parent: payment_links

Please note:

The payment_link array is required in a success or partial success response.
Each element in the payment_link array is an object responding to one requested link in the PBL request.

Each object in the payment_link array may contain the following:

Name	Requirement	Format	Description
`expiry`	Conditional Requirement: Required for successfully configured links.	String, in `yyyy-MM-dd HH:mm:ssZ` format	The date and time of this link's expiration, in UTC. Applicable to successfully configured links.
`id`	Conditional Requirement: Required for successfully configured links.	Integer	A unique identifier for a successfully generated payment link. In each response, this is `1` for the first link, and it increases by a value of 1 for each subsequent link. Applicable to successfully configured links.
`link`	Conditional Requirement: Required for successfully configured links.	String	The URL of the generated payment link. This can be sent to the customer to complete payment. Applicable to successfully configured links.
`order_summary`	Required	Object	See `order_summary`, below.
`status`	Required	Object	See `status`, below.

`order_summary`

Parents: payment_links: payment_link

The order_summary object is required in a success or partial success response, and it contains the following name-value pair:

Name	Requirement	Format of value	Description of value
`reference`	Conditional Requirement: Required in a success or partial success response.	String	The reference ID of the request for this link. This is found in the PBL request object for this link, as the value of `order_summary: reference`.

`status`

Parents (Success or Partial Success Response): payment_links: payment_link
Parent (Fail Response): payment_links

The status object is required. In a success or partial success response, it appears in each object in the payment_link array. In a fail response, it appears in the payment_links object.

The status object contains the following name-value pairs:

Name	Requirement	Format of value	Description of value
`code`	Required	Integer	A CellPoint Digital internal status code indicating if the payment link was successfully generated. Possible values: `200` - Success `1001` - Failed `1201` - Bad request `1200` - Bad request
`message`	Required	String	A message detailing the status code in `code`. Possible values: `code = 200` - `Payment Link Configured Successfully` `code = 1001` - `Failed to Configure Payment Link` `code = 1201` - `Bad Request. Invalid request data.` `code = 1200` - `Bad Request. Request should not contain more than 20 payment links.`