Skip to navigation

Signature required to submit an intelligent boarding application

Submitting an application now requires signer.signature and signer.signatureType. signer.signedDocumentReference no longer replaces the signature. If you send it, Payabli records it with the signature. If you submit applications with only signer.signedDocumentReference, add signer.signature and signer.signatureType to your submit requests.

If signer, signer.signature, or signer.signatureType is missing, empty, or only whitespace, the request returns HTTP 400 Bad Request with the error VALIDATION_ERROR, and the application isn’t submitted. This change affects the following endpoint:

See Manage applications with the API and Migrate from legacy boarding.

Addresses in people search results

People search results now include each person’s addresses. Before this change, search didn’t return addresses for people stored in Payabli. Each result has two new fields:

  • primaryAddress: the person’s primary address, or null when they have no address on file
  • addresses: every address on file for the person, or an empty array when they have none

Search results use a shorter address format than the person record, with street, city, state, and zip. This change affects the following endpoints:

See Manage people with the API to learn more.

Status labels in Pay Out query responses and exports

Pay Out query and detail responses now include a readable label next to each numeric status, so you don’t need to map status codes to names yourself. Each label field takes the name of its status field plus Label, with the same casing:

  • StatusLabel for payouts, outbound transfer details, bills, and payout subscriptions, next to Status (statusLabel next to status when you get a single payout subscription)
  • BatchStatusLabel for payout batches, next to BatchStatus
  • VendorStatusLabel for vendors, next to VendorStatus
  • transferStatusLabel for outbound transfers, next to transferStatus

For example, a bill with a Status of 20 has a StatusLabel of Approved. A label is null when Payabli doesn’t recognize the status code. No existing field changes.

CSV and XLSX exports of these reports also add a label column immediately after each status column, such as Status Label after Status, or Bill_Status_Label after Bill_Status. Every column after it shifts one place to the right. If you read exports by column position, update your integration to read the new layout.

This change affects the following endpoints:

See Pay Out statuses to learn more.

Gateway status and IDs on paypoint credentials

Each entry in a paypoint’s Credentials array now includes three fields:

  • active: true when the gateway for this credential is enabled for the paypoint, or null when the credential isn’t linked to a gateway
  • customerId: the customer ID configured for the gateway, or null when the gateway doesn’t use one or none is configured
  • clientId: the client ID configured for the gateway, or null when the gateway doesn’t use one or none is configured

No existing field changes. This change affects the following endpoints:

Payout batch date filters match the response dates

The batchDate and transferDate filters on payout batch queries now use UTC, the same time zone as the BatchDate and TransferDate values in the response. Before this change, the filters shifted the date you asked for by the time zone of the organization, paypoint, or user that made the request. Filtering by one day could return batches from a different day. Response values don’t change.

If your organization, paypoint, or user time zone isn’t UTC and you filter payout batches by date, check that your filters still return the batches you expect. This change affects the following endpoints:

Virtual card decline messages include the decline reason

When the processor declines a virtual card payout at capture, responseData.resultText now ends with the processor’s reason for the decline, and it no longer names the processor. The code at the start of the text is now the numeric HTTP status, such as 400, instead of its name, such as BadRequest. responseData.resultCode is still 3.

For example, a decline caused by an invalid ZIP code changes from a generic message to this text:

400: Bad Request - Invalid request data. INVALID ZIP CODE

If your integration matches on the text of resultText for virtual card declines, update it to the new format. This change affects the following endpoint:

Placeholder bill due dates are ignored

When you add or update a bill, Payabli now treats a dueDate earlier than 1900-01-01, such as 0001-01-01, as if you didn’t send it. A new bill gets today’s date (UTC) as its due date, and an updated bill keeps its stored due date. Valid due dates don’t change.

A recurring bill sent with one of these dates now returns error 3211 (invalid start date). If your integration sends placeholder due dates such as 0001-01-01, send a real due date or leave the field out. This change affects the following endpoints:

See API responses for the full list of response codes.