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

Endpoint Details

ParameterDescription
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/payments/ach
MethodPOST
HeadersContent-Type: application/json, Authorization
AuthenticationBearer Token

Request Body

ParameterTypeRestrictionRequiredDescription
account_idStringYesUnique ID of the account from which the payment will be made.
recipient_idStringYesUnique ID of the ACH recipient that will receive the payment.
amountObjectYesDefines the value and currency for the transaction.
valueStringYesAmount to transfer.
currencyStringYesTransaction currency. Must be "COP".
descriptionStringNoPayment reference: free-text field that allows any additional or custom information related to the transaction to be included.
typeint

amount.value refers to the value field inside the amount object.

Request Example

JSON
Copy

Response Body

  • HTTP Code: 200 OK
  • Returns the payment data along with its unique ID

Response Example

JSON
Copy
  1. The payment status will initially be PENDING. Once the payment is processed, it will change to SETTLED.

  2. The id shown in the response is the payment_id.

  3. 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 CodeMeaningDescription
400 Bad RequestInvalid dataRequired fields are missing or contain invalid values.
401 UnauthorizedInvalid tokenThe access token has expired or is invalid.
403 ForbiddenAccess deniedYou do not have permission to create a payment.
500 Server ErrorServer errorUnexpected error while processing the payment.

Best Practices

  • Verify that account_id and recipient_id correspond 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.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard