API Suite - July 2022 Release

Summary of changes for the API Suite functional release for July 2022

SWIFT GPI Integration

The API Suite is now connected to the Swift GPI network, where payment status information can be obtained. For the July release a new end point has been created providing for the ability to call the Swift network with the payment ID.

Details on the new end point can be found in the Swift GPI page.

The following is an example of the data returned.

{
    "transactionStatus": "ACSP",
    "transactionStatusReason": "G001",
    "statusDescription": "ReleasedNoLongerTraceable",
    "reasonDescription": "Payment transferred to a non- gpi agent and cannot be tracked",
    "trackingReference": "953d1561-08fa-4f3d-b268-fdfa9c892276",
    "originalPaymentId": "P8DshG6R5DXtA8gEt4GGAgrq0ZU8OkQg",
    "orderDetailId": 0,
    "initiationTime": "2022-03-22T12:27:36",
    "lastUpdatedTime": "2022-03-22T12:48:03.727",
    "instructedAmount": {
        "amount": 0.05,
        "currency": "USD"
    },
    "estimatedAmount": {
        "amount": 0.05,
        "currency": "USD"
    },
    "creditedAmount": {
        "amount": 0.0
    },
    "payerBank": {
        "bic": "BOFAUS3N",
        "institutionName": "BANK OF AMERICA, N.A."
    },
    "beneficiaryBank": {
        "bic": "BOFAUS3N",
        "institutionName": "BANK OF AMERICA, N.A."
    },
    "paymentEvents": [
        {
            "messageNameId": "199",
            "transactionStatus": "ACSP",
            "transactionStatusReason": "G001",
            "statusDescription": "ReleasedNoLongerTraceable",
            "reasonDescription": "Payment transferred to a non- gpi agent and cannot be tracked",
            "timeOutForInstitution": "2022-03-22T12:48:03.727",
            "senderAcknowledgementReceipt": "2022-03-22T12:47:38",
            "chargeType": "DEBT",
            "feeDeductAtInstitution": {
                "amount": 0.0
            },
            "correspondentBankFrom": {
                "bic": "IRVTUS30XXX",
                "institutionName": "TEST BANK BONY US"
            },
            "correspondentBankTo": {
                "bic": "TRCKCHZ0XXX"
            },
            "forwardedToAgent": {
                "bic": "BOFAUS3NXXX",
                "institutionName": "BANK OF AMERICA, N.A."
            }
        },
        {
            "messageNameId": "103",
            "transactionStatus": "ACSP",
            "transactionStatusReason": "G000",
            "statusDescription": "ReleasedInProcess",
            "reasonDescription": "Payment transferred to next gpi agent and can be tracked",
            "timeOutForInstitution": "2022-03-22T12:28:03.54",
            "timeInForInstitution": "2022-03-22T12:27:47",
            "senderAcknowledgementReceipt": "2022-03-22T12:27:36",
            "receivedDate": "2022-03-22T12:27:47",
            "chargeType": "DEBT",
            "feeDeductAtInstitution": {
                "amount": 0.0
            },
            "correspondentBankFrom": {
                "bic": "CHFXGB30XXX",
                "institutionName": "TEST BANK WUBS CUSTOM HOUSE"
            },
            "correspondentBankTo": {
                "bic": "IRVTUS30XXX",
                "institutionName": "TEST BANK BONY US"
            }
        }
    ]
}

Payment Transmission Confirmations

The API Suite has a new Payment Transmission Confirmation (PTC) end point that can be used for both SWIFT and Non-SWIFT payments, to obtain pertinent payment information.

Details on the new end point can be found in the Payments Transmission Confirmation page.

The following are examples of the data returned:
Non-SWIFT Payments

{
  "sender": "Customer House Financial (UK) Limited",
  "paymentMessageType": "NACHA",
  "transmissionDateTime": "2022-07-08T09:23:01.003"
}

SWIFT Payments

{
  "sender": "Western Union Business Solutions (USA), LLC",
  "paymentMessageType": "MT103",
  "trackingReferenceUETR": "J09BCvxJjZn1zUVBAM",
  "transmissionDateTime": "2022-07-08T08T09:27:01.003"
}

Same Day ACH Payments

On March 18, 2022, the Same Day ACH (SDA) limit increased from $100,000 to $1,000,000 per transaction and in our July release we have implemented this update. When the payment method is set to 'SDA' and the trade amount is equal to or less then $1,000,000 the payment will be accepted. When the trade amount is greater then $1,000,000 the payment will not be accepted, and the following error will be displayed.

The following is an example of the data returned.

{
    "payments": [
        {
            "id": "Payment123",
            "status": "NotAccepted",
            "errorCode": "1212:amount"
        }
    ]
}