Payments

Warning

api.payments.* is a deprecation shim. The canonical home for these methods is ab.api.endpoints.jobs.payment.JobPaymentEndpoint, reached as api.jobs.payment. Every call here emits a DeprecationWarning and forwards to the subgroup.

class ab.api.endpoints.payments.PaymentsEndpoint(client)[source]

Deprecated shim — every method forwards to api.jobs.payment.

get(job_display_id)[source]

Deprecated. Use api.jobs.payment.get(...).

Parameters:: job_display_id (int)
Return type:: PaymentInfo

get_create(job_display_id)[source]

Deprecated. Use api.jobs.payment.get_create(...).

Parameters:: job_display_id (int)
Return type:: PaymentInfo

get_sources(job_display_id)[source]

Deprecated. Use api.jobs.payment.get_sources(...).

Parameters:: job_display_id (int)
Return type:: list[PaymentSource]

pay_by_source(job_display_id, *, data)[source]

Deprecated. Use api.jobs.payment.pay_by_source(...).

Parameters:

job_display_id (int)
data (PayBySourceRequest | dict)

Return type:

ServiceBaseResponse

create_ach_session(job_display_id, *, data)[source]

Deprecated. Use api.jobs.payment.create_ach_session(...).

Parameters:

job_display_id (int)
data (ACHSessionRequest | dict)

Return type:

ACHSessionResponse

ach_credit_transfer(job_display_id, *, data)[source]

Deprecated. Use api.jobs.payment.ach_credit_transfer(...).

Parameters:

job_display_id (int)
data (ACHCreditTransferRequest | dict)

Return type:

ServiceBaseResponse

attach_customer_bank(job_display_id, *, data)[source]

Deprecated. Use api.jobs.payment.attach_customer_bank(...).

Parameters:

job_display_id (int)
data (AttachBankRequest | dict)

Return type:

ServiceBaseResponse

verify_ach_source(job_display_id, *, data)[source]

Deprecated. Use api.jobs.payment.verify_ach_source(...).

Parameters:

job_display_id (int)
data (VerifyACHRequest | dict)

Return type:

ServiceBaseResponse

cancel_ach_verification(job_display_id)[source]

Deprecated. Use api.jobs.payment.cancel_ach_verification(...).

Parameters:: job_display_id (int)
Return type:: ServiceBaseResponse

set_bank_source(job_display_id, *, data)[source]

Deprecated. Use api.jobs.payment.set_bank_source(...).

Parameters:

job_display_id (int)
data (BankSourceRequest | dict)

Return type:

ServiceBaseResponse

Methods

get

GET /job/{jobDisplayId}/payment — Get payment information for a job.

Returns: PaymentInfo

info = api.payments.get(job_display_id)

get_sources

GET /job/{jobDisplayId}/payment/sources — List payment sources.

Returns: list[PaymentSource]`

pay_by_source / set_bank_source

POST /job/{jobDisplayId}/payment/bysource and POST .../banksource — Execute payment.

Returns: ServiceBaseResponse

ACH operations

POST .../ACHCreditTransfer, POST .../attachCustomerBank, POST .../verifyJobACHSource, POST .../cancelJobACHVerification — ACH payment workflow.

Returns: ServiceBaseResponse