Retrieve an ACH payment intent by ID.

GET

/payments/ach/{id}

curl --request GET \
  --url https://api.paygasus.com/payments/ach/ach_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• secret_key

Parameters

Path Parameters

id

required

string

Example

ach_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

ACH payment intent ID

Responses

200

Payment intent found

Media typeapplication/json

object

amount

required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64

created

required

integer format: int64

currency

required

Currently supported currencies by Paygasus Pay

string

Allowed values: USD

description

string | null

id

required

string

livemode

required

boolean

metadata

required

object

key

additional properties

string

payment_method

required

object

account_holder_name

required

string

account_holder_type

required

string

Allowed values: personal business

account_last4

required

string

account_type

required

string

Allowed values: checking savings

routing_number

required

string

statement_descriptor

string | null

status

required

One of:

object

Draft, not yet submitted to FNBO.

object

status

required

string

Allowed values: created

object

Submitted; accepted by FNBO and awaiting submission to the Fed. The only state (besides created) from which a transfer can be canceled.

object

processor_ref

required

string

status

required

string

Allowed values: pending

submitted_at

required

string format: date-time

object

Being processed by FNBO.

object

processor_ref

required

string

started_at

required

string format: date-time

status

required

string

Allowed values: processing

object

Sent to the Fed. Reversible via the reversal endpoint; may still be returned later by the receiving bank.

object

processed_at

required

string format: date-time

processor_ref

required

string

status

required

string

Allowed values: processed

object

A created/pending transfer canceled before submission to the Fed.

object

canceled_at

required

string format: date-time

reason

required

string

status

required

string

Allowed values: cancelled

object

Returned by the Fed / receiving bank (e.g. R01 insufficient funds).

object

reason

required

string

returned_at

required

string format: date-time

status

required

string

Allowed values: returned

object

A processed transfer reversed by the originator.

object

processor_ref

required

string

reversed_at

required

string format: date-time

status

required

string

Allowed values: reversed

updated

required

integer format: int64

Example

{
  "amount": 1000,
  "currency": "USD",
  "id": "ach_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "payment_method": {
    "account_holder_name": "Jane Buyer",
    "account_holder_type": "personal",
    "account_last4": "6789",
    "account_type": "checking",
    "routing_number": "021000021"
  },
  "status": {
    "status": "created"
  }
}

404

No such payment intent

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

param

string | null

type

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}