Darf

Check DARF

post
/banking/cashout/darf/check

Check a DARF

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
Body

Check DARF request params

accumulated_revenue_amountintegerRequired

Accumulated revenue amount

amountintegerRequired

Amount

assessment_datestringRequired

Assessment date

authentication_datestringRequired

Authentication date

due_datestringRequired

Due date

federal_revenue_idstringRequired

Federal revenue ID

fine_amountintegerRequired

Fine amount

interest_amountintegerRequired

Interest amount

namestringRequired

Name

percentageintegerRequired

Percentage

phonestringRequired

Phone number

reference_numberinteger · nullableOptional

Reference number

tax_numberstringRequired

Tax number

Responses
post
/banking/cashout/darf/check

Pay DARF

post
/banking/cashout/darf/pay

Generate a pay DARF

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
Body

Body params to generate a DARF V1 payment

amountintegerOptional

Amount in cents

check_idstring · uuidRequired

Unique identifier

descriptionstringOptional

Description for the utility

external_idstringOptional

External ID for reference

virtual_account_idstring · uuidRequired

Unique identifier

Responses
post
/banking/cashout/darf/pay

Pay DARF v2

post
/banking/cashout/darf/pay/v2

Generate a pay DARF v2

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
Body

Body params to generate a DARF V2

accumulated_revenue_amountintegerRequired

Accumulated revenue amount

amountintegerRequired

Amount

assessment_datestringRequired

Assessment date

authentication_datestringRequired

Authentication date

descriptionstring · nullableOptional

Description of the DARF

due_datestringRequired

Due date

external_idstring · nullableOptional

External ID of the DARF for reference

federal_revenue_idstringRequired

Federal revenue ID

fine_amountintegerRequired

Fine amount

interest_amountintegerRequired

Interest amount

namestringRequired

Name

percentageintegerRequired

Percentage

phonestringRequired

Phone number

reference_numberinteger · nullableOptional

Reference number

tax_numberstringRequired

Tax number

virtual_account_idstring · uuidRequired

Unique identifier

Responses
post
/banking/cashout/darf/pay/v2

Last updated

Was this helpful?