Skip to content

Quickstart: Submitting Your First Transaction

Welcome to the GIB Fintech Payments API. This guide will help you submit your first ACH transaction using our RESTful API and understand the required elements for a successful test.

Prerequisites

The following configuration should be completed already. See the Getting Started guide for more information.

  • Company, user, and account setup completed by us
  • At least one valid user_account configured with routing/account number
  • Recommended: webhook URL configured to receive transaction updates

The code snippets provided in this scenario require the following variables:

  • BASE_API_URL - The target GIB API domain, which can be found in the API-Reference.
  • ACH_API_URL - The target GIB API domain for ACH transactions, which can be found in the API-Reference.
  • API_KEY - The API key setup by the client for using the API. Can be generated using the Dashboard.

Step 1 - Get Your API Key

API keys are user-specific and have an optional expiration and IP restrictions. They can be viewed or created in the dashboard under your user profile.

You must whitelist your IP address for the API key to work.

Step 2 - Format a File

You may upload a standard ACH file. Sample files are available in the documentation repository or from your onboarding contact. Make sure the routing/account numbers match your assigned user_account.

Using the parse endpoint is a good way to ensure your formatting is correct before upload.

Step 3 - Upload File

Use the file/create endpoint:

curl -X POST $ACH_API_URL/api/file/create \
  -H "Authorization: $API_KEY" \
  -F "file=@sample.ach"
  • File must be under 10MB
  • Must be a valid NACHA file, Moov-compatible WIRE/ICL format, or JSON file
  • If file contains many transactions, use the bulk endpoint. See Workflows for more details.

Step 4 - Monitor Status

Use the dashboard or transaction search endpoint:

curl -X GET $BASE_API_URL/api/transaction/search?state=created \
  -H "Authorization: $API_KEY"

You may also search by amount, reference, or trace number.

Step 5: Receive Webhook

If webhooks are enabled, you'll get JSON payloads about transaction updates. You can find the list of webhooks here.

What Happens to Your Transaction After Upload

  1. File parsed within 30 seconds, batch and transaction records created. If accepted, state changes to created. If rejected due to format errors or other automated systems, an error is returned or the state changes to failed and customer is notified via webhook.

  2. Automated and manual review by Bank.

  3. If accepted, transaction is prepared for submission to the Federal Reserve, state changes to processing and customer is notified via webhook.

  4. If rejected, generally due to compliance issues, state changes to failed and customer is notified via webhook.

  5. Submission to Federal Reserve. State changes to processed. customer is notified via webhook.