Skip to main content

Get Agreement Status

Overview

The agreement approval is an async flow, so your system needs to build a mechanism to check the status of the agreement after it has been created.

There are 2 ways to get the status of the agreement:

1. Listen to the webhook event `payto_agreement.*`

You can find more details about the webhook events in the PayTo Webhook documentation.

2. Poll the show agreement endpoint

GET /payto/agreements

Try It

You can test this endpoint using the following cURL command:

curl --request GET \
  --url 'https://api-sandbox.oligo.com.au/v1/payto/agreements/<your_agreement_uid>' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <your_token>' \
  --header 'content-type: application/json'

Overview
- 1. Listen to the webhook event payto_agreement.*
- 2. Poll the show agreement endpoint
Try It