Hold a payment

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment

string

required

Body

application/json

The body is of type object.

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

The type of the object in Nmbr ("payment").

data

Payment · object

Hide child attributes

data.payroll

object

Hide child attributes

data.payroll.id

string

read-only

The unique identifier of the object in Nmbr.

data.payroll.object

string

read-only

The type of the object in Nmbr ("payroll").

data.remittance_account

any

data.destination

enum<string>

Where the payment is destined. payroll_float is the funding debit from the employer's bank account. employee is a credit to an employee or contractor. cra and rq are remittances to the Canada Revenue Agency (CRA) and Revenu Québec (RQ), respectively.

Where the payment is destined. For example, employee for payments to employees, cra for remittances to CRA, payroll_float for business funding.

Available options:

bill_pay,

cra,

employee,

internal,

no_op,

payroll_float,

rq

data.method

enum<string>

How the payment will be processed. pad (Pre-Authorized Debit) is used for employer funding. direct_deposit is used for employee credits. manual indicates the payment is handled outside of Nmbr.

How the payment will be processed. For example, direct_deposit or pad.

Available options:

direct_deposit,

manual,

pad,

wire

data.amount

number<decimal>

The dollar amount of the payment.

data.status

enum<string>

The current processing status of the payment. Payments begin as pending, move to processing when submitted to the banking network, and settle as paid or failed. Held payments that pass their processing date become overdue.

Available options:

canceled,

failed,

overdue,

paid,

pending,

processing

data.process_at

string<date> | null

The date on which Nmbr will submit the payment to the banking network for processing.

data.expected_at

string<date>

The date on which the payment is expected to arrive at its destination.

data.is_impacted_by_weekend_or_holiday

boolean

Whether the payment dates have been adjusted due to a weekend or bank holiday.

data.is_held

boolean

Whether the payment is currently held. A held payment will not be submitted for processing until it is released.

data.held_at

string<dateTime> | null

read-only

The timestamp when the payment was placed on hold. null if the payment is not held.

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.