Forth Pay

Sections

Theme switcher

Generate CAA Document

Header Parameters

Api-Keystring Required

Body Parameters

doc_langstring

The language in which the document is generated.

firstnamestring Required

The first name of the customer.

middlenamestring

The middle name of the customer.

lastnamestring Required

The last name of the customer.

ssnstring Required

The Social Security Number of the customer for identification purposes.

date_of_birthstring Required

The date of birth of the customer associated with the document.

co_firstnamestring

The first name of the customer associated with the document.

co_middlenamestring

The middle name of the customer associated with the document.

co_lastnamestring

The last name of the customer associated with the document.

co_ssnstring

The Social Security Number of the customer associated with the document.

co_date_of_birthstring

The date of birth of the customer associated with the document.

addressstring Required

The primary address of the customer.

address2string

The secondary address of the customer.

citystring Required

The city where the customer resides.

statestring Required

The state where the customer resides.

zipstring Required

The zip code of the customer's address.

phonestring Required

The phone number of the customer for contact purposes.

alt_phonestring

An alternate phone number of the customer.

emailstring

The email address of the customer for communication purposes.

agent_namestring

The name of the agent who is generating the CAA document.

bank_namestring

The name of the bank where the customer holds an account.

bank_account_namestring

The name associated with the customer's bank account.

bank_account_numstring

The account number of the customer's bank account.

bank_routing_numstring

The routing number of the customer's bank.

bank_account_typestring

The type of bank account linked to the customer.

bank_addressstring

The address of the bank where the customer holds an account.

bank_statestring

The state where the customer's bank is located.

bank_zipstring

The zip code of the bank where the customer holds an account.

auth_amountstring

The authorized amount for the transaction associated with the document.

auth_datestring

The date when the authorization for the transaction was given.

paymentsarray

Contains information related to payments for the document.

Show child attributes

Response

200
Object
Successful Response

Response Attributes

statusobject

Specifies the status of the document generation process.

Show child attributes

responseobject

Contains the overall response data for the document generation process.

400
Object
Error Response

Response Attributes

statusobject Required

Specifies the status of the document generation process.

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?