Read a payin

GET

payins

{payinId}

curl --request GET \
  --url https://extensions-sandbox.lumx.io/payments/payins/{payinId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "pa_000000000000",
  "status": "processing",
  "pixCode": "12345678"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

payinId

string

required

200 - application/json

string

required

The ID of the payin.

status

enum<string>

required

The current status of the payin.

Available options:

processing,

failed,

refunded,

completed

pixCode

string

required

Pix code for the payin.

curl --request GET \
  --url https://extensions-sandbox.lumx.io/payments/payins/{payinId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "pa_000000000000",
  "status": "processing",
  "pixCode": "12345678"
}