Check Payment with Payable API
Check eligibility
Ensure the origination bank account is with Goldman Sachs and has been enabled for check payments during the business onboarding process. Please note that check payments are only available for domestic (US) transactions. If the origination bank account is not with Goldman Sachs, the payment will fail.
Create the Payable API Request
Ensure that the "payee" section includes both the payee's name and address, as these are required fields for a check payment.
To start a check payment, the "methodOfPayment" field in the API request must be set to "3", which signifies a check payment.
For successful payment, processing, the following fields are mandatory:
Address: Represents the mailing address of the recipient. This address will appear on the printed check.
Payee Name: Either an individual's name or a business name.
Memo: A brief note or reference that will also be printed on the check.
Certain fields have character restrictions for printing:
First Name & Last Name: Max 140 characters.
Address Line 1: Max 70 characters.
City: Max 35 characters.
Post Code: Max 16 characters.
Country Subdivision: Max 35 characters.
Memo: Max 70 characters.
Submit Payable API Request
Once the JSON structure is correctly formatted and populated with your data, submit the Payable API request as per the API documentation.
Verify Transaction
Upon successful submission, the API returns a response with the status of the payable. The payor should verify the status to confirm if the transaction was successful.
Example
{
"payable": {
"payableReferenceId": "INV_2438294071",
"recordNumber": "48c9303a-83b9-4cb4-a614-96936d99dc08",
"netTotal": 850.00,
"isoCurrencyCode": "USD",
"payableTerms": "NET30",
"payableDueDate": "2023-10-22",
"payableEffectiveDate": "2023-09-23",
"payableApprovalStatus": 2,
"memo": "Payment for IT Services - Invoice #INV_2438294071",
"payee": {
"partyReferenceId": "76252678-7627-4cfa-8c4d-1384ca8d3559",
"businessName": "Systemsia",
"isBusiness": true,
"phoneNumber": "2626135176",
"address": {
"addressLine1": "4685 Fairfield Road",
"addressLine2": "",
"addressLine3": "",
"townName": "Milwaukee",
"country": "USA",
"countrySubDivision": "WI",
"postCode": "53202"
}
}
},
"paymentInfo": {
"originationAccountReferenceId": "86f0fea3-8287-4c3d-b15d-44df1ea6cefd",
"destinationFinancialInformation": {
"isoCurrencyCode": "USD",
"methodOfPayment": 3,
"foreignExchangeInfo": {
"originationIsoCurrencyCode": "USD",
"destinationIsoCurrencyCode": "USD"
}
}
}
}