Get All Quote Purposes

GET 
/v1/crossborder/quotes/purposes

Retrieve a list of all crossborder quote purposes. Optional filter parameters can be used to refine your search.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [tag]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

Header Parameters

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

x-product-target-user-uuid string

UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses

200

Quote purposes returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Quotes data.
Array [
tag stringrequired
Quote purpose tag.
description stringrequired
Description.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "tag": "INTERNATIONAL_PERSONAL_REMITTANCE",
      "description": "Payment for services"
    }
  ]
}

401

User authentication failed.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 401,
  "error": "USER",
  "message": "Access is denied."
}

403

User access denied.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 403,
  "error": "USER",
  "message": "Access denied to requested resource. User may not have sufficient permission."
}

422

If any required params are missing or have invalid format or type.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 422,
  "error": "USER",
  "message": "Invalid quote currency amount. The minimum allowed is 100, and you requested 61.",
  "code": "INVALID_QUOTE_CURRENCY_MIN_AMOUNT"
}

Loading...