curl --request POST \
--url https://b.anny.co/api/v1/terminal-readers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "terminal-readers",
"attributes": {
"registration_code": "simulated-wpe",
"label": "Test Reader"
},
"relationships": {
"location": {
"data": {
"type": "terminal-locations",
"id": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "terminal-readers",
"attributes": {
"label": "<string>",
"provider_reader_id": "<string>",
"serial_number": "<string>",
"device_type": "<string>",
"device_sw_version": "<string>",
"ip_address": "<string>",
"status": "online",
"is_tap_to_pay": true,
"is_synced": true,
"display_label": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"links": {
"self": "<string>"
},
"relationships": {
"location": {
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"self": "<string>"
}
},
"payment_account": {
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"self": "<string>"
}
}
}
}
}Terminal Payments
Register terminal reader
Registers a new Stripe Terminal reader using the pairing code displayed on the device screen.
After the first reader is successfully registered, is_terminal_enabled on the payment account becomes true automatically.
Required: registration_code (or provider_reader_id), location relationship
POST
/
api
/
v1
/
terminal-readers
curl --request POST \
--url https://b.anny.co/api/v1/terminal-readers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "terminal-readers",
"attributes": {
"registration_code": "simulated-wpe",
"label": "Test Reader"
},
"relationships": {
"location": {
"data": {
"type": "terminal-locations",
"id": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "terminal-readers",
"attributes": {
"label": "<string>",
"provider_reader_id": "<string>",
"serial_number": "<string>",
"device_type": "<string>",
"device_sw_version": "<string>",
"ip_address": "<string>",
"status": "online",
"is_tap_to_pay": true,
"is_synced": true,
"display_label": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"links": {
"self": "<string>"
},
"relationships": {
"location": {
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"self": "<string>"
}
},
"payment_account": {
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"self": "<string>"
}
}
}
}
}Autorisierungen
The access token received from the authorization server in the OAuth 2.0 flow.
Abfrageparameter
Organization ID
Body
application/vnd.api+json
Show child attributes
Show child attributes
Antwort
Created
A physical Stripe Terminal card reader registered to an organization.
Show child attributes
Show child attributes