Get PayTo Agreement Details

get

https://au-0000.api.assemblypay.com/payto/agreements/{agreement_uuid}

Retrieve details of a PayTo agreement by UUID which uniquely identifies the agreement. This UUID is returned as part of the “Validate PayTo Agreement” operation.

It provides complete details of a particular agreement irrespective of its current status

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Error Code	Error Message
PAYT-ERR-2401	Invalid format for url param: agreement_uuid.

Error Code	Error Message
PAYT-ERR-1000	Invalid or missing authorisation token.

Error Code	Error Message
PAYT-ERR-1001	PayTo feature not available.

Error Code	Error Message
PAYT-ERR-2400	Agreement with provided uuid does not exist.

Error Code	Error Message
PAYT-ERR-1003	An error occurred processing your request. Please try again.

200OK

400Bad Request Error CodeError MessagePAYT-ERR-2401Invalid format for url param: agreement_uuid.

401Unauthorised Error CodeError MessagePAYT-ERR-1000Invalid or missing authorisation token.

403Forbidden Error CodeError MessagePAYT-ERR-1001PayTo feature not available.

404Not Found Error CodeError MessagePAYT-ERR-2400Agreement with provided uuid does not exist.

500Internal Server Error Error CodeError MessagePAYT-ERR-1003An error occurred processing your request. Please try again.