CAcardda
Bank recipient

Enroll one

This endpoint is meant to be used when a bank recipient fails to be enrolled or was deleted in the bank and returns to a 'draft' or 'deleted' status with a null transition, so this endpoint can be used to re enroll that same recipient which will update the null transition once again to 'enroll'.

post/v1/banking/bank_recipients/{bank_recipient_id}/enroll

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_recipients/{bank_recipient_id}/enroll
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1banking~1bank_recipients~1%7Bbank_recipient_id%7D/get/parameters/1 (unresolved $ref)

Request body

bank_key_idstring uuid

Optional selector for the bank key. When omitted, the highest-priority approved bank key of the owning account for your user is used.

authorization_method'digipass' | 'device'

Authorization method — Banco de Chile only. Defaults to digipass.

tokenstring

One-time password. Required for Banco de Chile on enroll — sent together with device_id (both are required as a pair; they are not alternatives).

device_idstring uuid

Bank device UUID for Cardda Device users. Required for Banco de Chile on enroll — sent together with token (both are required as a pair; device_id does not replace token).

Example request

{
  "bank_key_id": "47b93e3d-36a6-423a-acbe-c23b5484c3ed"
}

Response

Enrolled bank recipient — re-enrollment enqueued

idstring uuid required
namestring
aliasstring
owner_idstring uuid required
rutstring

The rut must not contain dots or hyphens, and if it ends up with a k this letter should be capitalized

emailstring
account_type'corriente' | 'vista' | 'ahorro' | 'clabe'

Chilean account types are the following:

  • 'corriente'
  • 'vista'
  • 'ahorro'

Mexican account types are the following:

  • 'clabe'

For more details check the guide.

account_numberstring required
person_idstring uuid

the id of the company that owns this recipient

bank_id'cl_banco_de_chile' | 'cl_banco_internacional' | 'cl_banco_scotiabank' | 'cl_banco_scotiabank_azul' | 'cl_banco_bci' | 'cl_banco_bice' | 'cl_hsbc_bank' | 'cl_banco_santander_chile' | 'cl_banco_itau' | 'cl_banco_security' | 'cl_banco_falabella' | 'cl_banco_ripley' | 'cl_banco_consorcio' | 'cl_banco_btg_pactual_chile' | 'cl_banco_estado' | 'cl_banco_corpbanca' | 'cl_banco_paris' | 'cl_coopeuch' | 'cl_mercado_pago' | 'cl_prepago_los_heroes' | 'cl_tapp_caja_los_andes' | 'cl_tenpo_prepago_sa' | 'cl_banco_del_desarrollo' | 'cl_transbank' | 'cl_banco_do_brasil' | 'cl_jp_morgan_chase_bank' | 'cl_mufg_bank' | 'cl_banco_sudamericano' | 'cl_rabobank' | 'cl_china_construction_bank' | 'cl_bank_of_china' | 'cl_banco_de_la_nacion_argentina' | 'cl_banco_penta' | 'cl_abn_amro_bank' | 'mx_banxico' | 'mx_bancomext' | 'mx_banobras' | 'mx_banjercito' | 'mx_nafin' | 'mx_babien' | 'mx_hipotecaria_fed' | 'mx_banamex' | 'mx_bbva_mexico' | 'mx_santander' | 'mx_hsbc' | 'mx_bajio' | 'mx_inbursa' | 'mx_mifel' | 'mx_scotiabank' | 'mx_banregio' | 'mx_invex' | 'mx_bansi' | 'mx_afirme' | 'mx_banorte' | 'mx_bank_of_america' | 'mx_mufg' | 'mx_jp_morgan' | 'mx_bmonex' | 'mx_ve_por_mas' | 'mx_azteca' | 'mx_autofin' | 'mx_barclays' | 'mx_compartamos' | 'mx_multiva_banco' | 'mx_actinver' | 'mx_intercam_banco' | 'mx_bancoppel' | 'mx_abc_capital' | 'mx_consubanco' | 'mx_volkswagen' | 'mx_cibanco' | 'mx_bbase' | 'mx_bankaool' | 'mx_pagatodo' | 'mx_inmobiliario' | 'mx_donde' | 'mx_bancrea' | 'mx_banco_covalto' | 'mx_icbc' | 'mx_sabadell' | 'mx_shinhan' | 'mx_mizuho_bank' | 'mx_bank_of_china' | 'mx_banco_s3' | 'mx_monexcb' | 'mx_gbm' | 'mx_masari' | 'mx_value' | 'mx_vector' | 'mx_finamex' | 'mx_valmex' | 'mx_profuturo' | 'mx_cb_intercam' | 'mx_ci_bolsa' | 'mx_fincomun' | 'mx_nu_mexico' | 'mx_reforma' | 'mx_stp' | 'mx_credicapital' | 'mx_kuspit' | 'mx_unagra' | 'mx_asp_integra_opc' | 'mx_alternativos' | 'mx_libertad' | 'mx_caja_pop_mexica' | 'mx_cristobal_colon' | 'mx_caja_telefonist' | 'mx_transfer' | 'mx_fondo_fira' | 'mx_invercap' | 'mx_fomped' | 'mx_tesored' | 'mx_nvio' | 'mx_indeval' | 'mx_arcus' | 'pe_banco_bcp' | 'pe_banco_yape'
external_idstring uuid
bank_former_namestring
status'draft' | 'enrolled' | 'preauthorized' | 'deleted' | 'approved'
transition'enroll' | 'authorize' | 'preauthorize' | 'delete' nullable
bank_errorsItems[] (unresolved $ref)
metadataunknown
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.