Request Pay Entry

Individual entry within a request-to-pay batch including amount and recipient details.

additionalReferencestring

Additional reference for the payment entry.

baseAmountnumber<double>

Base payment amount before fees.

companyNamestring

Company name associated with this payment entry.

customerFeenumber<double>

Fee charged to the customer.

customerNamestring

Name of the customer for this payment entry.

customerReferencestring

Reference identifier for the customer in this payment entry.

emailstring

Email address for payment notifications.

entryStatusstring

Current status of this payment entry.

failureCodestring

Error code for the payment failure.

failureReasonstring

Reason the payment failed.

isPaymentRecalledboolean

Whether the payment has been recalled.

isPaymentRefundedboolean

Whether the payment has been refunded.

isPaymentRetryScheduledboolean

Whether a payment retry has been scheduled.

lastDigitsstring

Last digits of the payment card used.

merchantCodestring

Merchant code.

merchantFeenumber<double>

Fee charged to the merchant.

merchantNamestring

Merchant trading name.

merchantWithheldAmountnumber<double>

Amount withheld from the merchant.

mobilestring

Mobile number for payment notifications.

oneOffPaymentReferencestring

Reference for a one-off payment.

paymentAmountnumber<double>

Amount to be paid in this entry.

paymentCardstring

Card details associated with the payment.

paymentDatestring<date-time>

Scheduled date for the payment.

paymentMethodstring

Method used for payment (e.g. card, direct debit).

paymentReferencestring

Unique reference for the payment transaction.

paymentResourcestring

Resource identifier for the payment.

paymentStatusstring

Payment processing status.

processedAmountnumber<double>

Total amount processed including fees.

processingDatestring<date-time>

Date the payment was processed.

processorReferencestring

Reference assigned by the payment processor.

recalledOnstring<date-time>

Date and time the payment was recalled.

recalledReasonstring

Reason the payment was recalled.

refundedOnstring<date-time>

Date and time the payment was refunded.

refundedReasonstring

Reason the payment was refunded.

requestReferencestring

Reference to the parent request-to-pay batch.

retryPaymentReferencestring

Reference for the retry payment transaction.

retryPaymentResourcestring

Resource identifier for the retry payment.

retryPaymentStatusstring

Status of the retry payment.

retryScheduledOnstring<date-time>

Date and time the retry is scheduled for.

settlementDatestring<date-time>

Date the payment was settled.

Request Pay Entry

{
  "additionalReference": "string",
  "baseAmount": 0,
  "companyName": "string",
  "customerFee": 0,
  "customerName": "string",
  "customerReference": "string",
  "email": "string",
  "entryStatus": "string",
  "failureCode": "string",
  "failureReason": "string",
  "isPaymentRecalled": true,
  "isPaymentRefunded": true,
  "isPaymentRetryScheduled": true,
  "lastDigits": "string",
  "merchantCode": "string",
  "merchantFee": 0,
  "merchantName": "string",
  "merchantWithheldAmount": 0,
  "mobile": "string",
  "oneOffPaymentReference": "string",
  "paymentAmount": 0,
  "paymentCard": "string",
  "paymentDate": "2024-07-29T15:51:28.071Z",
  "paymentMethod": "string",
  "paymentReference": "string",
  "paymentResource": "string",
  "paymentStatus": "string",
  "processedAmount": 0,
  "processingDate": "2024-07-29T15:51:28.071Z",
  "processorReference": "string",
  "recalledOn": "2024-07-29T15:51:28.071Z",
  "recalledReason": "string",
  "refundedOn": "2024-07-29T15:51:28.071Z",
  "refundedReason": "string",
  "requestReference": "string",
  "retryPaymentReference": "string",
  "retryPaymentResource": "string",
  "retryPaymentStatus": "string",
  "retryScheduledOn": "2024-07-29T15:51:28.071Z",
  "settlementDate": "2024-07-29T15:51:28.071Z"
}