List Authorizations

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/automatic-pix/authorizations \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": 1,
    "merchant_id": 1,
    "contract_id": "123",
    "identifier": "identifier",
    "frequency": "MONTHLY",
    "contract_name": "Contract Name",
    "type": "RECURRING",
    "authorization_amount": 100.00,
    "amount": 100.00,
    "maximum_authorization_amount": 200.00,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31",
    "created_at": "2023-01-01T00:00:00Z",
    "status": {
      "id": 1,
      "name": "ACTIVE"
    },
    "history": [
      {
        "id": 1,
        "authorization_id": 1,
        "status_id": 1,
        "status_name": "ACTIVE",
        "created_at": "2023-01-01T00:00:00Z"
      }
    ],
    "buyer": {
      "id": 1,
      "name": "Buyer Name",
      "document": "12345678900"
    }
  }
]

GET

automatic-pix

authorizations

List Authorizations

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/automatic-pix/authorizations \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": 1,
    "merchant_id": 1,
    "contract_id": "123",
    "identifier": "identifier",
    "frequency": "MONTHLY",
    "contract_name": "Contract Name",
    "type": "RECURRING",
    "authorization_amount": 100.00,
    "amount": 100.00,
    "maximum_authorization_amount": 200.00,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31",
    "created_at": "2023-01-01T00:00:00Z",
    "status": {
      "id": 1,
      "name": "ACTIVE"
    },
    "history": [
      {
        "id": 1,
        "authorization_id": 1,
        "status_id": 1,
        "status_name": "ACTIVE",
        "created_at": "2023-01-01T00:00:00Z"
      }
    ],
    "buyer": {
      "id": 1,
      "name": "Buyer Name",
      "document": "12345678900"
    }
  }
]

Response

array

List of authorizations

Show authorization object

integer

Authorization ID

merchant_id

integer

Merchant ID

contract_id

string

Contract ID

identifier

string

Identifier

frequency

string

Frequency

contract_name

string

Contract Name

type

string

Type

authorization_amount

number or null

Authorization Amount

amount

number or null

Amount

maximum_authorization_amount

number or null

Maximum Authorization Amount

start_date

string

Start Date

end_date

string or null

End Date

created_at

string

Creation Date

status

object

Status

Show status properties

integer

Status ID

name

string

Status Name

history

array or null

History

Show history items

integer

History ID

authorization_id

integer

Authorization ID

status_id

integer

Status ID

status_name

string

Status Name

created_at

string

Date

buyer

object

Buyer

Show buyer properties

integer

Buyer ID

name

string

Buyer Name

document

string

Buyer Document

[
  {
    "id": 1,
    "merchant_id": 1,
    "contract_id": "123",
    "identifier": "identifier",
    "frequency": "MONTHLY",
    "contract_name": "Contract Name",
    "type": "RECURRING",
    "authorization_amount": 100.00,
    "amount": 100.00,
    "maximum_authorization_amount": 200.00,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31",
    "created_at": "2023-01-01T00:00:00Z",
    "status": {
      "id": 1,
      "name": "ACTIVE"
    },
    "history": [
      {
        "id": 1,
        "authorization_id": 1,
        "status_id": 1,
        "status_name": "ACTIVE",
        "created_at": "2023-01-01T00:00:00Z"
      }
    ],
    "buyer": {
      "id": 1,
      "name": "Buyer Name",
      "document": "12345678900"
    }
  }
]

Create Authorization Get Authorization

​Response

Response