Ajustes

Listar afiliaciones

GET

/v1/merchant-accounts

const url = 'https://api.timbro.do/v1/merchant-accounts?limit=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.timbro.do/v1/merchant-accounts?limit=20' \
  --header 'Authorization: Bearer <token>'

Autenticación

secretKey
adminKey

Parámetros

Parámetros de consulta

limit

integer

default: 20 >= 1 <= 100

Filas de una página.

cursor

string

>= 1 characters <= 512 characters

El nextCursor de la página anterior. Un cursor pertenece a la lista, el negocio, el modo y el conjunto de filtros que lo emitieron.

Respuestas

200

Una página de afiliaciones, de la más reciente a la más antigua.

application/json

Campos y códigos de la respuesta

Una página de afiliaciones, de la más reciente a la más antigua.

object

object

obligatorio

string

Valor permitido: list

data

obligatorio

Array<object>

Afiliación del comercio con su adquirente.

object

obligatorio

Identificador de la afiliación.

string

/^merchant_account_[0-9a-hjkmnp-tv-z]{24,}$/

object

obligatorio

string

Valor permitido: merchant_account

provider

obligatorio

Cualquiera de:

string
string

string

Valor permitido: azul

mode

obligatorio

Cualquiera de:

string
string

string

Valor permitido: test

lifecycle

obligatorio

Cualquiera de:

string
string

string

Valor permitido: active

readiness

obligatorio

object

status

obligatorio

Cualquiera de:

string
string

string

Valor permitido: ready

blockers

obligatorio

Array<object>

object

code

obligatorio

Cualquiera de:

string

Valor permitido: merchant_account_disabled

owner

obligatorio

Cualquiera de:

string

Valor permitido: merchant

detail

string

>= 1 characters <= 256 characters

checks

obligatorio

Array<object>

object

check

obligatorio

string

>= 1 characters <= 64 characters

status

obligatorio

Cualquiera de:

string

Valor permitido: passed

detail

string

>= 1 characters <= 256 characters

capabilities

obligatorio

Array<object>

unique items

Disponibilidad de una operación de la afiliación para el comercio. Nunca se devuelven credenciales del adquirente ni detalles del protocolo.

object

purpose

obligatorio

Cualquiera de:

string

Valor permitido: payment

Solo en modo de prueba. Es la página del adquirente, presente mientras la afiliación la tenga habilitada. Un pago solo la usa cuando envía checkoutPreferences.paymentPage.

string

Valor permitido: payment_page

readiness

obligatorio

object

status

obligatorio

Cualquiera de:

string
string

string

Valor permitido: ready

blockers

obligatorio

Array<object>

object

code

obligatorio

Cualquiera de:

string

Valor permitido: merchant_account_disabled

owner

obligatorio

Cualquiera de:

string

Valor permitido: merchant

detail

string

>= 1 characters <= 256 characters

checks

obligatorio

Array<object>

object

check

obligatorio

string

>= 1 characters <= 64 characters

status

obligatorio

Cualquiera de:

string

Valor permitido: passed

detail

string

>= 1 characters <= 256 characters

credentialVersion

integer

>= 1

checkoutCapabilities

obligatorio

Capacidades disponibles de Checkout para una afiliación y un modo, sin datos sensibles.

object

splits

obligatorio

boolean

wallets

obligatorio

Array

<= 2 items unique items

threeDsModes

obligatorio

Array

<= 2 items unique items

createdAt

obligatorio

string format: date-time

venueReference

string

>= 1 characters <= 256 characters

credentialVersion

integer

>= 1

hasMore

obligatorio

Verdadero cuando existe otra página después de esta.

boolean

nextCursor

obligatorio

Cualquiera de:

string
null

string

>= 1 characters

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

400

No se pudo entender la solicitud.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "No se pudo entender la solicitud.",
  "status": 400,
  "code": "parameter_invalid",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: parameter_invalid collection_cursor_invalid

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 400

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

401

La credencial falta, tiene un formato incorrecto o ya no es válida.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial falta, tiene un formato incorrecto o ya no es válida.",
  "status": 401,
  "code": "api_key_missing",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: api_key_missing api_key_invalid checkout_token_invalid checkout_token_expired

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 401

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

403

La credencial es válida, pero no tiene permiso para realizar esta operación.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial es válida, pero no tiene permiso para realizar esta operación.",
  "status": 403,
  "code": "operation_not_permitted",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: operation_not_permitted

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 403

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

500

La solicitud no pudo completarse. Recupera el resultado con la referencia guardada o repite la solicitud con la misma clave de idempotencia.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La solicitud no pudo completarse. Recupera el resultado con la referencia guardada o repite la solicitud con la misma clave de idempotencia.",
  "status": 500,
  "code": "internal_error",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: internal_error

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 500

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.