Title
Create new category
Edit page index title
Edit category
Edit link
Initiate ACH Payment
Overview
This endpoint allows you to initiate a payment through the ACH rail using the Passport API. A successful request creates the payment object and returns the transaction details, including its status and recipient information.
Requirement
ACH Recipient successfully created beforehand.
Endpoint Details
Parameter | Description |
|---|---|
Endpoint | https://api.paas.sandbox.co.passportfintech.com/v1/payments/ach |
Method | POST |
Headers | Content-Type: application/json, Authorization |
Authentication | Bearer Token |
Request Body
Parameter | Type | Restriction | Required | Description |
|---|---|---|---|---|
account_id | String | Yes | Unique ID of the account from which the payment will be made. | |
recipient_id | String | Yes | Unique ID of the ACH recipient that will receive the payment. | |
amount | Object | Yes | Defines the value and currency for the transaction. | |
value | String | Yes | Amount to transfer. | |
currency | String | Yes | Transaction currency. Must be | |
description | String | No | Payment reference: free-text field that allows any additional or custom information related to the transaction to be included. | |
type | int | Code used for the transaction type in different scenarios according to the table: Disbursement:
|
amount.value refers to the value field inside the amount object.
Request Example
Response Body
HTTP Code:
200 OKReturns the payment data along with its unique ID
Response Example
The payment status will initially be
PENDING. Once the payment is processed, it will change toSETTLED.The
idshown in the response is thepayment_id.When you make an ACH Payment, it will show up in the GET Account call. The pending balance will be updated. Once the ACH payment is processed, it will lower the pending balance and update your available balance.
Common Errors and Handling
HTTP Code | Meaning | Description |
|---|---|---|
400 Bad Request | Invalid data | Required fields are missing or contain invalid values. |
401 Unauthorized | Invalid token | The access token has expired or is invalid. |
403 Forbidden | Access denied | You do not have permission to create a payment. |
500 Server Error | Server error | Unexpected error while processing the payment. |
Best Practices
Verify that
account_idandrecipient_idcorrespond to valid entities.Monitor the payment status (
PENDING,SETTLED, etc.) to confirm processing.Implement error handling in your integration to manage rejections or processing delays.