Sign in

v1

latestOpenAPI 3.1.02026-08-06142966.9 KB
instruments

Get Instrument

Get an instrument by ID.

get/instruments/{instrument_id}

Path parameters

instrument_idstring uuid required

Headers

X-API-Keystring nullable

Response

Successful Response

org_idstring uuid required

ID of the organization this instrument belongs to

customer_idstring uuid required

ID of the customer that owns this instrument

type'mx_direct_debit_card' | 'mx_clabe' required

Instrument type enum.

descriptionstring nullable

Description of the instrument

status'active' | 'inactive' | 'verification_in_progress' | 'errored'

Instrument status enum.

currencystring nullable

ISO 4217 currency code

ownership_verification_result'no_match' | 'matched' | 'errored'

Verification result enum.

ownership_verification_result_atstring date-time nullable

When ownership verification was completed

idstring uuid required
created_atstring date-time required
updated_atstring date-time nullable