Skip to main content

Outbound ACH Credit

The 'Outbound ACH Credit' API enables to process the ACH credit transaction initiated by the sender to send funds to the beneficiary bank account

Method: POST​

{{URL}}/rpc/paymentv2

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

method

Mandatory

String

API method that is being called to initiate ACH transaction through ledger service

Constant value – "ledger.ach.transfer"

id

Mandatory

String

Unique ID of API request

Sample value – "1"

params

Mandatory

Object

payload

Mandatory

Object

channel

Mandatory

String

Payment channel through which the transaction is processed

Constant value – "ACH"

transactionType

Mandatory

String

Type of transaction

Constant value – "ACH_OUT"

product

Mandatory

String

Application from where the transaction in initiated

Constant value – "LEDGER"

program

Mandatory

String

Program name/id of a customer typically includes the customer ID

Sample value – "100000000000005"

transactionDateTime

Optional

String

Date and time of the transaction is initiated (format: "YYYY-MM-DD HH:MM:SS")

Sample value – "2021-01-19 06:20:25"

reference

Mandatory

String

Unique reference ID of the transaction

Sample value – "REF16170620220966"

reason

Optional

String

Purpose of the transaction

Sample value – "Settlement"

transactionAmount

Mandatory

Object

amount

Mandatory

String

Amount of the transaction

Sample value – "900"

currency

Mandatory

String

Type of currency used for transaction

Sample value – "USD"

debtor

Mandatory

Object

userType

Optional

Enum

Type of debtor

Valid values:

  • ACCOUNT_HOLDER
  • ACCOUNT_HOLDER_BUSINESS
  • LEGAL_REP
  • NON_ACCOUNT_HOLDER
  • NON_ACCOUNT_HOLDER_BUSINESS
  • ORIGINATOR
  • ORIGINATOR_BUSINESS
  • SHAREHOLDER
  • SIGNATORY
  • SHAREHOLDER_BUSINESS
  • TELLER
  • TECHNOLOGY_SERVICE_PROVIDER
  • MSB
  • VIRTUAL_ACCOUNT_HOLDER
  • NONE
  • BENEFICIARY
  • INDIVIDUAL
  • BILLER
  • BSA_OFFICER
  • CONTROLPERSON
  • KEYMANAGEMENT
  • CONSUMER
  • MERCHANT

Sample value – "INDIVIDUAL"

identification

Optional

String

Value of identification type

Sample value – "89900200002"

identificationType

Optional

String

Identification type of debtor

Constant value – "SSN"

firstName

Mandatory

String

First name of debtor

Sample value – "Andy"

middleName

Optional

String

Middle name of debtor

Sample value – "Lee"

lastName

Optional

String

Last name of debtor

Sample value – "Prescott"

debtorPostalAddress

Optional

Object

addressType

Optional

String

Address type of debtor

Sample value – "HOUSE"

addressLine1

Optional

String

First line of debtor address

Sample value – "3745SWWanamakerRD"

addressLine2

Optional

String

Second line of debtor address

Sample value – "SuiteC"

city

Optional

String

City of debtor address

Sample value – "Topeka"

state

Optional

String

State of debtor address

Sample value – "KS"

zipCode

Optional

String

ZIP Code of debtor address

Sample value – "66610"

countryCode

Optional

String

Country code of debtor address

Sample value – "840"

debtorContact

Optional

Object

primaryEmail

Optional

String

Primary email id of debtor

Sample value – "aprescott@demobank.com"

primaryPhone

Optional

String

Primary phone number of debtor

Sample value – "7850010001"

debtorAccount

Mandatory

Object

identification

Mandatory

String

Value of identification type

Sample value – "200524894086671"

identificationType

Mandatory

String

Identification type of debtor account

Sample value – "ACCOUNT_NUMBER"

institution

Mandatory

Object

name

Optional

String

Financial Institution or Bank name where the debtor holds the account

Sample value – "FINWISE BANK"

identification

Mandatory

String

Value of identification type

Sample value – "011000015"

identificationType

Mandatory

String

Identification type of debtor's financial institution or bank

Sample value – "ABA"

creditor

Mandatory

Object

userType

Mandatory

Enum

Type of creditor

Valid values:

  • ACCOUNT_HOLDER
  • ACCOUNT_HOLDER_BUSINESS
  • LEGAL_REP
  • NON_ACCOUNT_HOLDER
  • NON_ACCOUNT_HOLDER_BUSINESS
  • ORIGINATOR
  • ORIGINATOR_BUSINESS
  • SHAREHOLDER
  • SIGNATORY
  • SHAREHOLDER_BUSINESS
  • TELLER
  • TECHNOLOGY_SERVICE_PROVIDER
  • MSB
  • VIRTUAL_ACCOUNT_HOLDER
  • NONE
  • BENEFICIARY
  • INDIVIDUAL
  • BILLER
  • BSA_OFFICER
  • CONTROLPERSON
  • KEYMANAGEMENT
  • CONSUMER
  • MERCHANT

Sample value – "INDIVIDUAL"

identification

Optional

String

Value of identification type

Sample value – "89900200014"

identificationType

Optional

String

Identification type of creditor

Constant value – "SSN"

firstName

Mandatory

String

First name of creditor

Sample value – "Andy"

_middleName

Optional

String

Middle name of creditor

Sample value – "Lee"

lastName

Optional

String

Last name of creditor

Sample value – "Prescott"

creditorPostalAddress

Mandatory

Object

addressType

Optional

String

Address type of creditor

Sample value – "HOUSE"

addressLine1

Mandatory

String

First line of creditor address

Sample value – "3745SWWanamakerRD"

addressLine2

Optional

String

Second line of creditor address

Sample value – "SuiteC"

city

Optional

String

City of creditor address

Sample value – "Topeka"

state

Optional

String

State of creditor address

Sample value – "KS"

zipCode

Mandatory

String

ZIP Code of creditor address

Sample value – "66610"

countryCode

Mandatory

String

Country code of creditor address

Sample value – "840"

creditorContact

Mandatory

Object

primaryEmail

Mandatory

String

Primary email id of creditor

Sample value – "aprescott@demobank.com"

primaryPhone

Mandatory

String

Primary phone number of creditor

Sample value – "7850010001"

creditorAccount

Mandatory

Object

identification

Mandatory

String

Value of identification type

Sample value – "6000000000000006"

identificationType

Mandatory

String

Identification type of creditor account

Sample value – "ACCOUNT_NUMBER"

identificationType2

Optional

Enum

Additional identification type of creditor account

Valid values:

  • SAVINGS - To deposit for saving purpose
  • CHECKING - For daily use
  • WALLET - To store pre-paid money for daily usage
  • MONEY_MARKET - Interest bearing account (based on interest rates)
  • CREDIT_CARD - To track only the credit card transactions
  • GL - General Ledger for accounting record
  • CUSTODIAL - For the benefit of other financial institution

Sample value – "SAVINGS"

institution

Optional

Object

name

Optional

String

Financial Institution or Bank name where the creditor holds the account

Sample value – "FINWISE BANK"

identification

Mandatory

String

Value of identification type

Sample value – "011002550"

identificationType

Mandatory

String

Identification type of creditor's financial institution or bank

Sample value – "ABA"

api

Mandatory

Object

credential

Mandatory

String

API credential provided by FinWise

Sample value – "Credential"

signature

Mandatory

String

Signature for request validation

Sample value – "signature"

apiKey

Mandatory

String

API key used for user authentication

Sample value – "ApiKey"


curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"method":"ledger.ach.transfer","id":"1","params":{"payload":{"channel":"ACH","transactionType":"ACH_PULL","product":"LEDGER","program":"100000000000005","reference":"R90987895","transactionDateTime":"2021-01-19 06:20:25","reason":"Settlement","transactionAmount":{"amount":"200","currency":"USD"},"debtor":{"userType":"INDIVIDUAL","identification":"89900200002","identificationType":"SSN","firstName":"nashe","middleName":"","lastName":""},"debtorPostalAddress":{"addressType":"HOUSE","addressLine1":"3745 SW anamaker RD","addressLine2":"Suite C","city":"Topeka","state":"KS","zipCode":"66610","countryCode":"840","nationality":"USA"},"debtorContact":{"primaryEmail":"n.sundar@netsys-inc.com","primaryPhone":"7850010001"},"debtorAccount":{"identification":"200000000852262","identificationType":"ACCOUNT_NUMBER","identificationType2":"SAVINGS","institution":{"name":"FINWISE BANK","identification":"011110646","identificationType":"ABA"}},"creditorAccount":{"identification":"200827921990857","identificationType":"ACCOUNT_NUMBER"}},"api":{"signature":"{{Signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}","apiKey":"{{ApiKey}}"}}}'

Body​


{
  "method": "ledger.ach.transfer",
  "id": "1",
  "params": {
    "payload": {
      "channel": "ACH",
      "transactionType": "ACH_OUT",
      "product": "LEDGER",
      "program": "100000000000005",
      "transactionDateTime": "2021-01-19 06:20:25",
      "reference": "REF16170620220966",
      "reason": "Settlement",
      "transactionAmount": {
        "amount": "900",
        "currency": "USD"
      },
      "debtor": {
        "userType": "INDIVIDUAL",
        "identification": "89900200002",
        "identificationType": "SSN",
        "firstName": "Andy",
        "middleName": "Lee",
        "lastName": "Prescott"
      },
      "debtorPostalAddress": {
        "addressType": "HOUSE",
        "addressLine1": "3745SWWanamakerRD",
        "addressLine2": "SuiteC",
        "city": "Topeka",
        "state": "KS",
        "zipCode": "66610",
        "countryCode": "840"
      },
      "debtorContact": {
        "primaryEmail": "aprescott@demobank.com",
        "primaryPhone": "7850010001"
      },
      "debtorAccount": {
        "identification": "200524894086671",
        "identificationType": "ACCOUNT_NUMBER",
        "institution": {
          "name": "FINWISE BANK",
          "identification": "011000015",
          "identificationType": "ABA"
        }
      },
      "creditor": {
        "userType": "INDIVIDUAL",
        "identification": "89900200014",
        "identificationType": "SSN",
        "firstName": "Andy",
        "_middleName": "Lee",
        "lastName": "Prescott"
      },
      "creditorPostalAddress": {
        "addressType": "HOUSE",
        "addressLine1": "3745SWWanamakerRD",
        "addressLine2": "SuiteC",
        "city": "Topeka",
        "state": "KS",
        "zipCode": "66610",
        "countryCode": "840"
      },
      "creditorContact": {
        "primaryEmail": "aprescott@demobank.com",
        "primaryPhone": "7850010001"
      },
      "creditorAccount": {
        "identification": "6000000000000006",
        "identificationType": "ACCOUNT_NUMBER",
        "identificationType2": "SAVINGS",
        "institution": {
          "name": "FINWISE BANK",
          "identification": "011002550",
          "identificationType": "ABA"
        }
      }
    },
    "api": {
      "credential": "{{Credential}}",
      "signature": "{{signature}}",
      "apiKey": "{{ApiKey}}"
    }
  }
}

Response: 200​

Response Parameters
ParameterDescription

id

String

Response ID echoed from the request ID

Sample value – "1"

result

Object

api

Object

type

String

Type of transaction

Constant value – "ACH_OUT_ACK"

reference

String

Unique reference Id of the transaction

Sample value – "REF16170620220966"

dateTime

String

Date and time of the transaction is initiated (format: "YYYY-MM-DD HH:MM:SS")

Sample value – "2023-05-02 16:55:44"

account

Object

accountId

String

Unique account Id of debtor

Sample value – "200524894086671"

balanceCents

Number

Remaining account balance of debtor in cents

Sample value – 27400

status

Enum

Status of the debtor account

Valid values:

  • CREATED - Account has been newly created
  • ACTIVE - Account is currently active and can be used for transactions
  • CURTAILED - Account functionalities are limited
  • DORMANT - Account is inactive for a specific period
  • SUSPENDED - Account is Temporarily disabled
  • BLOCKED - Account is restricted from performing any transactions
  • CLOSED - Account is permanently terminated and can no longer be used
  • DISABLED - Account is inactive and unusable, either temporarily or permanently

Sample value – "ACTIVE"

transactionNumber

String

Unique transaction number that is assigned for the transaction

Sample value – "QA00000000008002"

transactionStatus

Enum

Status of the transaction

Valid values:

  • COMPLETED
  • PENDING
  • FAILED
  • DECLINED
  • REJECTED

Sample value – "COMPLETED"

transactionAmountCents

Number

Transaction amount in cents

Sample value – 900

originalRequestBase64

String

Base64 encoded data for received xml message

Sample value – "Base64 encoded data for received xml message"

processId

String

Unique process ID assigned to track end to end process of transaction

Sample value – "PL23050200008002"

header

Object

reference

String

Unique reference ID of the transaction

Sample value – "REF16170620220966"

apiKey

String

API key used for user authentication

Sample value – "ApiKey"

signature

String

Signature for request validation

Sample value – "signature"


{
  "id": "1",
  "result": {
    "api": {
      "type": "ACH_OUT_ACK",
      "reference": "REF16170620220966",
      "dateTime": "2023-05-02 16:55:44"
    },
    "account": {
      "accountId": "200524894086671",
      "balanceCents": 27400,
      "status": "ACTIVE"
    },
    "transactionNumber": "QA00000000008002",
    "transactionStatus": "COMPLETED",
    "transactionAmountCents": 900,
    "originalRequestBase64": "eyJjaGFubmVsIjoiQUNIIiwidHJhbnNhY3Rpb25UeXBlIjoiQUNIX09VVCIsInByb2R1Y3QiOiJMRURHRVIiLCJwcm9ncmFtIjoiMTAwMDAwMDAwMDAwMDA1IiwidHJhbnNhY3Rpb25EYXRlVGltZSI6IjIwMjEtMDEtMTkgMDY6MjA6MjUiLCJyZWZlcmVuY2UiOiJSRUYxNjE3MDYyMDIyMDk2NiIsInJlYXNvbiI6IlNldHRsZW1lbnQiLCJ0cmFuc2FjdGlvbkFtb3VudCI6eyJhbW91bnQiOiI5MDAiLCJjdXJyZW5jeSI6IlVTRCJ9LCJkZWJ0b3IiOnsidXNlclR5cGUiOiJJTkRJVklEVUFMIiwiaWRlbnRpZmljYXRpb24iOiI4OTkwMDIwMDAwMiIsImlkZW50aWZpY2F0aW9uVHlwZSI6IlNTTiIsImZpcnN0TmFtZSI6IkFuZHkiLCJtaWRkbGVOYW1lIjoiTGVlIiwibGFzdE5hbWUiOiJQcmVzY290dCJ9LCJkZWJ0b3JQb3N0YWxBZGRyZXNzIjp7ImFkZHJlc3NUeXBlIjoiSE9VU0UiLCJhZGRyZXNzTGluZTEiOiIzNzQ1U1dXYW5hbWFrZXJSRCIsImFkZHJlc3NMaW5lMiI6IlN1aXRlQyIsImNpdHkiOiJUb3Bla2EiLCJzdGF0ZSI6IktTIiwiemlwQ29kZSI6IjY2NjEwIiwiY291bnRyeUNvZGUiOiI4NDAifSwiZGVidG9yQ29udGFjdCI6eyJwcmltYXJ5RW1haWwiOiJhcHJlc2NvdHRAZGVtb2JhbmsuY29tIiwicHJpbWFyeVBob25lIjoiNzg1MDAxMDAwMSJ9LCJkZWJ0b3JBY2NvdW50Ijp7ImlkZW50aWZpY2F0aW9uIjoiMjAwNTI0ODk0MDg2NjcxIiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQUNDT1VOVF9OVU1CRVIiLCJpbnN0aXR1dGlvbiI6eyJuYW1lIjoiQ0JXQkFOSyIsImlkZW50aWZpY2F0aW9uIjoiMDExMDAwMDE1IiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQUJBIn19LCJjcmVkaXRvciI6eyJ1c2VyVHlwZSI6IklORElWSURVQUwiLCJpZGVudGlmaWNhdGlvbiI6Ijg5OTAwMjAwMDE0IiwiaWRlbnRpZmljYXRpb25UeXBlIjoiU1NOIiwiZmlyc3ROYW1lIjoiQW5keSIsImxhc3ROYW1lIjoiUHJlc2NvdHQifSwiY3JlZGl0b3JQb3N0YWxBZGRyZXNzIjp7ImFkZHJlc3NUeXBlIjoiSE9VU0UiLCJhZGRyZXNzTGluZTEiOiIzNzQ1U1dXYW5hbWFrZXJSRCIsImFkZHJlc3NMaW5lMiI6IlN1aXRlQyIsImNpdHkiOiJUb3Bla2EiLCJzdGF0ZSI6IktTIiwiemlwQ29kZSI6IjY2NjEwIiwiY291bnRyeUNvZGUiOiI4NDAifSwiY3JlZGl0b3JDb250YWN0Ijp7InByaW1hcnlFbWFpbCI6ImFwcmVzY290dEBkZW1vYmFuay5jb20iLCJwcmltYXJ5UGhvbmUiOiI3ODUwMDEwMDAxIn0sImNyZWRpdG9yQWNjb3VudCI6eyJpZGVudGlmaWNhdGlvbiI6IjYwMDAwMDAwMDAwMDAwMDYiLCJpZGVudGlmaWNhdGlvblR5cGUiOiJBQ0NPVU5UX05VTUJFUiIsImlkZW50aWZpY2F0aW9uVHlwZTIiOiJTQVZJTkdTIiwiaW5zdGl0dXRpb24iOnsibmFtZSI6IkNCV0JBTksiLCJpZGVudGlmaWNhdGlvbiI6IjAxMTAwMjU1MCIsImlkZW50aWZpY2F0aW9uVHlwZSI6IkFCQSJ9fX0=",
    "processId": "PL23050200008002"
  },
  "header": {
    "reference": "REF16170620220966",
    "apiKey": "{{ApiKey}}",
    "signature": "MEYCIQDGEwm53WA37MS2rrD5f+4YckigGnAtbSDUeQhIBw3IMwIhANX5feV6uRKGnSfnyu2KkwZRWcSknghJWldQKdoXl/f3"
  }
}