API Suite - December 2024 Release Notes

The December release contains a new payment status webhook along with miscellaneous bug fixes.

New Webhook Status: Payment Sent to Gateway

As of this release, there will be a new webhook status for status = Sent. This status will occur between today's Processing and Released statuses and indicates the payment has been sent to our gateway for release.

The status will be added to the Get Payment by ID endpoints in an upcoming release. The updated status definition for Sent can be found in the Payment Statuses page.

{
  "id": "eacabcbf-a7fa-42f1-903a-6ae453a28931",
  "eventType": "payment.statusChanged",
  "createdOnUTC": "2024-11-14T16:30:06Z",
  "summary": "A payment status has been changed.",
  "resource": {
    "id": "123456789",
    "batchId": "BatchId123",
    "customerId": "customer_01",
    "partnerReference": "optional partner reference data",
    "status": "Sent",
    "errorCode": null,
    "createdOn": "2024-11-14T16:30:06Z",
    "lastUpdatedOn": "2024-11-14T16:30:06Z",
    "isDoddFrank": "False",
    "outgoingOrderId": "Order123"
  }
}

Purpose of Payment Code added to PFG API

The following currencies will now display that a payment.purposeOfPaymentCode is required to process the payment.

AED, BHD, BRL, CNY, CNH, INR, JOD, KZT, PHP, PKR

Note: this is not the same as payment.purposeOfPayment. Specific code definitions can be reviewed in the Payments Formatting Guide.

SWIFT character validation enhancement

The API will now only validate payment fields that are sent with the payment. A full list of payment fields where only SWIFT valid characters are allowed is now located in the Formatting Standards page.

New Field: Validation in Progress Count

A new field has been added to the Get the Batch details endpoint that indicates how many payments in the batch are currently in validation progress. This can be used in conjunction with the number of accepted payments to determine the validation status of the batch.

As a reminder, quotes should not be committed until all payments have completed validation.

{
    "id": "0WWgZESHhwjpWuExn0slP3ij92ArB3CK",
    "reference": "QNIWppi4n3nW6SkOFB1kULPMjkDgieu9",
    "createdOn": "2024-12-11T15:50:07Z",
    "lastUpdatedOn": "2024-12-11T15:50:07Z",
    "numberOfReceivedPayments": 2,
    "numberOfAcceptedPayments": 1,
    "numberOfInProgressPayments": 0, //New field added
    "aggregateAmounts": [
        {
            "isFixedOnSettlement": false,
            "currency": "GBP",
            "settlementCurrency": "USD",
            "amount": 500
        }
    ]
}

Miscellaneous Bug Fixes

PO Box should be accepted for payments where it is allowed. Note: PO boxes are not allowed for any payments into or out of Canada and non-local payments for the United States and Australia.
Fixed an issue where multiple drafts could be submitted in one payment request
Fixed an issue where duplicate payment IDs sent in multiple batches caused a 404 to return when querying the batch status
Fixed an issue where some prefunding payments would get delayed in payments workflow