Payout Catalog

Get user agreement

This GET endpoint is used to retrieve the user agreement for payout services. <br> You can use this endpoint to obtain information about the available user agreements for payout services offered by MassPay. <br> To use this endpoint, you need to provide the ID representing the user agreement as a required parameter in the URL Path. <br> The response will include the user agreement details.

get/payout/user-agreements

Request

Base URL
https://api.masspay.io/v1.0.0
Auth
- API key in header Authorization
- or API key in header x-api-key
TypeScript
https://skmtc.dev/masspay/apis/masspay-api/docs/payout/user-agreements/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

idinteger required

Example:2

Id representing user agreement (retrieved from OPTIONS call)

Response

Successful operation.

namestring required

Name of user agreement

contentstring byte required

Base64 encoded byte representing the content of the file

last_modifiedstring date-time required

Time when the agreement was last updated

idinteger required

Id representing the user agreement

mime_typestring

Mime type of the user agreement (i.e application/pdf)

Example response

{
  "name": "MassPay Card Program - USD",
  "last_modified": "2020-07-21T17:32:28Z",
  "id": 2,
  "mime_type": "application/pdf"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.