Resources

ACH Received Payment

AchReceivedPayment is a JSON:API resource, top-level fields:

Name	Type	Description
id	string	Identifier of the received payment resource.
type	string	Type of the transaction resource. The value is always `achReceivedPayment`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer related transactions).

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all receive payment types.
status	string	The status of the Received Payment. One of `Pending`, `PendingReview`, `MarkedForReturn`, `Advanced`, `Completed` or `Returned`, see Received Payment Statuses.
wasAdvanced	boolean	Will be `true` if the received payment was or is being Advanced (has or has had the status `Advanced`).
isAdvanceable	boolean	Will be `true` if the received payment can be advanced.
direction	string	The direction in which the funds flow (either `Debit` or `Credit`).
completionDate	RFC3339 Date string	Shows the date on which the received ACH will be completed (settled or repaid).
returnReason Optional	string	Optional. The reason if the received payment is `Returned`. See ACH return reasons.
amount	integer	The amount (cents) of the ACH received payment.
description	string	ACH description (maximum of 10 characters), also known as Company Entry Description.
addenda Optional	string	Optional. Additional transaction description (maximum of 80 characters).
companyName	string	The name by which the originator is known to the receiver.
originatorEntityId Optional	string	Optional. A unique identifier by which the originator is formally recognized within the ACH network.
receivingEntityName Optional	string	Optional. The name of the Recipient as it was declared by the originator of the payment.
counterpartyRoutingNumber	string	The routing number of the party that originated the received ACH payment.
traceNumber	string	The ACH Trace Number.
secCode Optional	string	Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. `WEB`, `CCD`, `PPD`, etc.).
returnCutoffTime Optional	RFC3339 Date string	Optional. The last time when a reprocess will be accepted. Will be the next banking day 2pm ET.
canBeReprocessed Optional	boolean	Optional. If set to `true`, the Received Payment can be reprocessed until the `returnCutoffTime`. If empty, the Received Payments can't be reprocessed.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction	Optional, JSON:API Relationship	The transaction of the received payment, created due to advance or when the ACH is processed.
paymentAdvanceTransaction	Optional, JSON:API Relationship	The transaction that funded the Advance from the provisional credit operating account, if the received payment was advanced.
repayPaymentAdvanceTransaction	Optional, JSON:API Relationship	The transaction that repaid the advance once the received payment is completed.
stopPayment Optional	JSON:API Relationship	Optional. Available for payments that were stopped.

Example AchReceivedPayment resource:
{
  "type": "achReceivedPayment",
  "id": "1337",
  "attributes": {
    "createdAt": "2022-02-01T12:03:14.406Z",
    "status": "Completed",
    "wasAdvanced": true,
    "isAdvanceable": false,
    "direction": "Credit",
    "amount": 100000,
    "completionDate": "2022-01-23",
    "companyName": "Uber",
    "counterpartyRoutingNumber": "051402372",
    "description": "Sandbox Transaction",
    "traceNumber": "123456789123456",
    "secCode": "PPD",
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "163555"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "129522"
      }
    },
    "receivePaymentTransaction": {
      "data": {
        "type": "transaction",
        "id": "101"
      }
    },
    "paymentAdvanceTransaction": {
      "data": {
        "type": "transaction",
        "id": "202"
      }
    },
    "repayPaymentAdvanceTransaction": {
      "data": {
        "type": "transaction",
        "id": "890"
      }
    }
  }
}

Received ACH Transaction

ReceivedAchTransaction is a JSON:API resource, top-level fields:

Name	Type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `receivedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
companyName	string	The name by which the originator is known to the receiver.
counterpartyRoutingNumber	string	The routing number of the originator.
description	string	ACH description (maximum of 10 characters), also known as Company Entry Description.
traceNumber	string	The ACH Trace Number.
secCode Optional	string	Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. `WEB`, `CCD`, `PPD`, etc.).
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
receivedPayment	JSON:API Relationship	The Received Payment the transaction belongs to.

Example ReceivedAchTransaction resource:
{
  "type": "receivedAchTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Received ACH | Company: UBER LTD",
    "companyName": "UBER LTD",
    "counterpartyRoutingNumber": "051402372",
    "description": "paycheck",
    "traceNumber": "123456789123456",
    "secCode": "PPD"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    },
    "receivedPayment": {
      "data": {
        "type": "receivedPayment",
        "id": "10000"
      }
    }
  }
}

Returned Received ACH Transaction

ReturnedReceivedAchTransaction is a JSON:API resource, top-level fields:

Name	Type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `returnedReceivedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created.
direction	string	The direction in which the funds flow.
amount	integer	The amount (cents) of the transaction.
balance	integer	The account balance (cents) after the transaction.
summary	string	Summary of the transaction.
companyName	string	The name by which the originator is known to the receiver.
reason	string	The ACH Return Reason code.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to.
receivedPayment	JSON:API Relationship	The Received Payment the transaction belongs to.
relatedTransaction	JSON:API Relationship	The original Received ACH Transaction that was returned.

Example ReturnedReceivedAchTransaction resource:
{
  "type": "returnedReceivedAchTransaction",
  "id": "9548",
  "attributes": {
    "createdAt": "2020-07-06T15:49:36.864Z",
    "direction": "Debit",
    "amount": 1000,
    "balance": 11000,
    "summary": "Returned Received ACH | Reason: InsufficientFunds",
    "companyName": "UBER LTD",
    "reason": "InsufficientFunds"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    },
    "receivedPayment": {
      "data": {
        "type": "receivedPayment",
        "id": "10000"
      }
    }
  }
}

Payment Advance Transaction

PaymentAdvanceTransaction is created when a Received Payment is advanced.

Name	Type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `paymentAdvanceTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created.
direction	string	The direction in which the funds flow.
amount	integer	The amount (cents) of the transaction.
balance	integer	The account balance (cents) after the transaction.
summary	string	Summary of the transaction.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to.
receivedPayment	JSON:API Relationship	The Received Payment that was advanced.

Example PaymentAdvanceTransaction resource:
{
  "type": "paymentAdvanceTransaction",
  "id": "9549",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Payment Advance | Company: UBER LTD"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    },
    "receivedPayment": {
      "data": {
        "type": "receivedPayment",
        "id": "10000"
      }
    }
  }
}

Declined Incoming Payment

DeclinedIncomingPayment is a JSON:API resource created when an incoming ACH payment is declined before a received payment is created.

Name	Type	Description
id	string	Identifier of the declined incoming payment resource.
type	string	Type of the resource. The value is always `declinedIncomingPayment`.
attributes	JSON Object	JSON object representing the declined incoming payment data.
relationships	JSON:API Relationships	Describes relationships between the resource and other resources.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
amount	integer	The amount (cents) of the declined payment.
direction	string	The direction in which the funds would have flowed.
reason	string	The reason the payment was declined.
paymentType	string	The type of payment that was declined (e.g., `AchPayment`).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account the payment was intended for.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to.

Example DeclinedIncomingPayment resource:
{
  "data": [
    {
      "type": "declinedIncomingPayment",
      "id": "1",
      "attributes": {
        "direction": "Credit",
        "amount": 10000,
        "reason": "NoAccount",
        "paymentType": "AchPayment",
        "createdAt": "2020-01-13T16:01:19.346Z"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "555"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "99823"
          }
        }
      }
    }
  ]
}

ACH Received Payment​

Attributes​

Relationships​

Received ACH Transaction​

Attributes​

Relationships​

Returned Received ACH Transaction​

Attributes​

Relationships​

Payment Advance Transaction​

Attributes​

Relationships​

Declined Incoming Payment​

Attributes​

Relationships​

ACH Received Payment

Attributes

Relationships

Received ACH Transaction

Attributes

Relationships

Returned Received ACH Transaction

Attributes

Relationships

Payment Advance Transaction

Attributes

Relationships

Declined Incoming Payment

Attributes

Relationships