Payments
payments
Methods
get/v1/payments
List all the payments for the provided search criteria.
post/v1/payments
Initiates a payment between a financial account and an external bank account.
Response fields
Balance
Request example
200Example
get/v1/payments/{payment_token}
Get the payment by token.
Simulate Release Payment -> { debugging_request_id, result, transaction_event_token }
post/v1/simulate/payments/release
Simulates a release of a Payment.
Simulate Return Payment -> { debugging_request_id, result, transaction_event_token }
post/v1/simulate/payments/return
Simulates a return of a Payment.
post/v1/payments/{payment_token}/retry
Retry an origination which has been returned.
post/v1/payments/{payment_token}/return
Return an ACH payment with a specified return reason code. Returns must be initiated within the time window specified by NACHA rules for each return code (typically 2 banking days for most codes, 60 calendar days for unauthorized debits). For a complete list of return codes and their meanings, see the ACH Return Reasons documentation.
Note:
- This endpoint does not modify the state of the financial account associated with the payment. If you would like to change the account state, use the Update financial account status endpoint.
- By default this endpoint is not enabled for your account. Please contact your implementations manager to enable this feature.
Simulate Receipt -> { debugging_request_id, result, transaction_event_token }
post/v1/simulate/payments/receipt
Simulates a receipt of a Payment.
Simulate Payment Lifecycle Event -> { debugging_request_id, result, transaction_event_token }
post/v1/simulate/payments/{payment_token}/action
Simulate payment lifecycle event
Domain types
Payment = { token, category, created, 19 more... }
Payment transaction
