Create allow/block list cashout
POST/v1/permissions/allow-block-lists/cashout
Creates the allow/block list cashout config. Only one active config is allowed per wallet.Tag: api-paas-post-permissions-allow-block-lists-cashout
Request
Header Parameters
Sender Wallet UUID (if empty, your default Wallet UUID will be settled)
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
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.
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.
Possible values: [pt-BR, en-US]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.
- application/json
Body
required
Possible values: [ALLOW, BLOCK]
List mode. ALLOW: cashouts are sent only to documents in the wallet list. BLOCK: cashouts to documents in the wallet list are rejected.
Responses
- 201
- 400
- 401
- 422
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [ALLOW, BLOCK]
{
"id": "string",
"wallet_id": "string",
"mode": "ALLOW",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
If any required params are missing or has invalid format or type.
User authentication failed.
If the wallet already has an active config.