API Reference

Submit a payment request

post
https://aws-agreement-api.tackle.io/api/agreements//payment-requests

Submits a charge against a variable payment term on the agreement. termId
identifies the variable payment term to bill.

The request is created at VALIDATING or PENDING_APPROVAL depending on
validation. The buyer must approve the charge before it is applied. Poll the
list or get endpoint for status updates.

clientToken is the idempotency key. Reusing it returns the original result
instead of creating a duplicate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
^[A-Za-z0-9_/-]+$

Agreement identifier

Body Params
string
required
length between 5 and 64

Short label for the charge

string
required

Positive decimal amount as a string in the agreement currency

string
length ≤ 2000

Optional note included with the request

string
required

Idempotency key. Reusing it returns the original result.

string
required

Variable payment term ID for the agreement

Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?